From 342ca5c43d4a477ccaf274cb15ce3f3d1bf92789 Mon Sep 17 00:00:00 2001 From: therve Date: Tue, 23 Mar 2021 14:35:54 +0000 Subject: [PATCH] Move templates in clients (#331) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * renaming for openapi-generator * Rename projects from swagger-codegen master branch * Add OpenAPI spec 3.0 support (beta) Co-authored-by: Akihito Nakano Co-authored-by: Jeremie Bresson Co-authored-by: Jim Schubert Co-authored-by: Martin Delille Co-authored-by: Tomasz Prus Co-authored-by: William Cheng * update discriminator to discriminatorName (#142) * fix: python clients (#136) * fix: python client * fix: regenerate petstore samples for python-asyncio/tornado * fix: python-asyncio tests * fix: python-tornado tests * chore: update python samples * fix: enable tests for python-tornado * fix: discriminator property * fix: file type * python: regenerate samples * fix: define file as generic type * update default user agent (#284) * Update wordings (#301) * update wordings * update git_push wordings * update git clone * update homepage url * update meta-codegen sample * Merge 'master' branch of 'swagger-codegen' into 'openapi-generator' (#327) * Update python default value (#360) * update pythong default value * fix example, update python sample * update python petstore sample (asyncio, tornado) * Update python test (#426) * update python test folders * update python template * update python samples * fix python comment too long * update ruby test case * Rename datatype to dataType in CodegenProperty (#69) * [python] asyncio supports _preload_content; remove unsed imports (#107) * chore: update python samples * feat: python/asyncio support for _preload_content * feat: remove unused imports from python clients; fix discriminator * Grammar and spelling fixes (#329) * Improve logging in Python client (#480) * improve logging in python client * update samples * feat: use local_var_params to avoid collision with api parameters (#521) * [Python][Client] pure library client package (#470) * Python client pure library package * check onlyPackage CLI option * run /bin/python-petstore.sh, update the python samples for CI * onlyPackage local variable instead of classp property * fix CI: __future__ absolute_import must be first in file * update samples * generateSourceCodeOnly * updated samples * Support for python 3.7 by renaming `async` to `async_req` (#519) * feat: support for python 3.7 * fix: regenerate other sample clients * fix: python-asyncio/aiohttp with disabled ssl verification (#891) * [PYTHON] Api doc python with multiple authentications (#928) * [PYTHON] better code snippet for API usage with authentication * update python samples * Add nullable support to Python client (#1073) * add nullable support to python client * update PR template * fix: python/asyncio no-ssl-verify affects verification of server certs only (#1211) Bug fix: python/asyncio no-ssl-verify affects verification of server certs * Fix W605 Warning and reenable flake8 (#1334) * [python] Avoid creating unused ThreadPools (#1387) * Avoid creating unused ThreadPools Instead, create ApiClient.pool on first request for .pool property. avoids spawning n-cpus threads (the default for ThreadPool) at instantiation of every ApiClient * update doc * set pool_thread to None * change python pool_thread default to 1 (#1403) * feat: [python/asyncio] use ssl argument instead of ssl_context (deprecated from aiohttp>=3.0.0) (#1724) * [python-client] Add model default values (#1776) * Adds two models to the v2.0 spec, uses examples as defaults in python client * Adds array default and type_holder_default and type_holder_example tests * Re-generated python security client with ./bin/security/python-petstore.sh * Changes comment text, rebased master * Updates client + server samples * Adds missing samples updates * Changes python client to look for true or false with booleans in toDefaultValue * Changes boolean casting to use Boolean.valueOf * Adds deserialization fix for python tests * Changes Mock to namedtuple in python deserialization tests * Actually remove unittest.mock * Python: Update api_doc_example for multiple auth (#1870) APIs may more than one auth method (for example both an app key and basic auth). This changes the example to only initialize the config option once instead of once per auth method. * [Spec] adds XmlItem model and route for xml testing (#1883) * Adds xmlitem model and route, rest-assured Api suffix fix, updates pytest and pytest-cov versions * Adds python client sample files * Adds samples update * Adds rest-assured sample client update * Adds sample updates in ensure-up-to-date * Changes rest-assured files back to master version, removes fix for issue #13 * Updates samples * Add multiple servers support to Python client (#1969) * add multiple server support to python client * various fixes * minor fixes, add tests * test oas2 python first * fix tests * fix issues reported by flake8 * update code format * add python petstore to ensure up-to-date * rearrange test * fix E501 * fix tests * add new files * fix script permission * fix index check * update samples * Add Bearer authentication support to Python client (#1999) * add bearer auth support to python * add bearer auth support to python * update python oas2 petstore samples * update samples * add bearer format * update php symfony samle * [Python] Add "servers" support in path, operation (#2052) * add servers to path, operation * add path/operation server support to python client * update python samples * fix index * fix python code style * [Python] handle nullable parameters with None added to allowed_values (#2034) * handle nullable parameters with None added to allowed_values * update samples * spec for testing enum with null/nullable * Python apikey cookie (#2367) * The `ApiClient` will now have support to store and use HTTP Cookies (as APIKey auth). * Use Cookie authentication for user management. * - Updated Python related samples. * Adding retries option to override default value 3 of urllib3 (#2460) * adding retries option to override default value 3 of urllib3 * running petstore for python * adding files for samples in petstore run * running ensure-up-to-date * Adds exceptions module to python clients (#2393) * Adds python client exceptions module and updates samples * Adds python style updates, detects integers in exception paths with six * Updates to ruby samples which circleci needs * Removes petstore-security-tests samples * readme char removal (triggers ci tests) * Readme fix, triggers CI tests * Updates python client sample * Added proxy headers option for urllib3 (#2467) * adding headers option to pass in rest client * running ensure uptodate * [Bug][Python]Support body as bytes when Content-Type is unknown (#2626) * Support body as bytes when Content-Type is unknownfix #2623 * Revert unwanted import changes * update samples/openapi3 * python: api_client: add the multipart files after sanitization (#2122) * python: api_client: add the multipart files after sanitization * simplify prepare_post_parameters * fix case of both post params and files set * update samples * update samples * Minor wording change (#2875) * better wording for version of openapi doc * update petstore samples * [Python] Remove unnecessary if else. (#2985) * Remove Unnecessary `if else` * update samples * [Python] ModuleNotFoundError when packagename contains dots (#2992) * feat(python): Support package names with dots * feat(python): Fixing tests * feat(python): Adding comment * fix(python): Fixing indentation * fix(python): Fixing indentation * [python] Adding constructor parameters to Configuration and improving documentation (#3002) * feat(python): Updated configuration's constructor and documentation * feat(python): Updated documentation * feat(python): Updated pet project * feat(python): Updated pet project * feat(python): Fixing host * feat(python): Updating pet project * feat(python): Fixing indentation * feat: configurable limit of simultaneous connections (python/asyncio) (#3200) * feat: configurable limit of simultaneous connections (python/asyncio) * fix: remove unused import (python/asyncio) * [python] : Make example code snippet compilable (#3148) * feat(python): Making example compilable * feat(python): Updating pet project * feat(python): Updating comments * feat(documentation): Fixing comments style * feat(documentation): Updating documentation * feat(documentation): Fixing comments style * [python-experimental] automatically use values for enums of length1 (#3118) * Update python client java generator * Updates python generator mustache files * Python sample regenerated * Switches from getfullargspec to getargspec for python2 compatibility * Uses getattr to get model class init method to correctly see its arguments, linting fixes to pass python tests * Updates comment in python centerator to restart CI tests * Adds bin/windows/python-experimental-petstore.bat * CHanges spec update to apply to the python-experimental spec * Moves new python templates to python-experimental * Moves generator python java code to python-experimental * Reverts python generator mustache files * Regenerates python, v3 python, python-experimental samples * Test moved to python-experimental, unused python files removed * [Python] avoid unnecessary dictionary lookup in get_api_key method (#3592) * [Python] support api key refresh in configuration module (#3594) * Exclude "test" from packages so that it is not installed as top-level package when "pip installing" the generated sdk (#3731) * Support custom git repository (#3757) * add gitHost param to GeneratorSettings and related * parameterize gitHost in READMEs * parameterize gitHost in go.mod * parameterize gitHost in git_push * update petstore samples * run ./bin/utils/export_docs_generators.sh * run meta-codehen.sh * Revert "run meta-codehen.sh" This reverts commit d6d579f6159186531257cdfdd73b9caf9e9ffeba. * Revert "run ./bin/utils/export_docs_generators.sh" This reverts commit 1b81538198d4319fd1b4e97447303e3cc0e8dc99. * Revert "update petstore samples" This reverts commit f513add88396707f6991ae2e4920359583ec88f1. * run ensure-up-to-date * [python-experimental] generate model if type != object if enums/validations exist (#2757) * Python-experimental adds model_utils module, refactors python api class * Fixes python-experimental so the sample sare generated in the petstore_api folder * FIxes python samples tests * Updates python and python-experimental tests * Fixes python-experimental tests * Adds newlines back to python templates + samples * Reverts files with newline tweaks back to master branch versions * Fixes indentation errors in python-experimental api_client * Removes unused files * Python files now generated in correct folders * Adds logging when the user tries to set generateAliasAsModel in python-experimental * Fixes typo * Fixed Readonly Docs for python (#4085) * Fix readonly with isReadOnly (#4102) * fix readonly * update samples * Skip adding None value in query parameters (#4161) * [python] Remove post_params and body from OPTIONS request (#4163) * Remove post_params and body from OPTIONS * Empty commit to retrigger build * [python] Add option to skip client validations (#4137) * Adds options to skip client side validations * Runs petstore.sh * Correct typo in variable name * Consistent code styling * Rerun petstore.sh * Change position of local_vars_configuration * Make code pep8 compliant * [Python] Minor fix to code format (#4172) * test python e501 fix * 2 spaces * fix format with noqa: E501 * fix format, update samples * [python] Add ability to get allowed values (#4138) * Add function to get list of allowed values * [python] Add function to get list of allowed values * Remove temporary variable * Remove static method and use a variable * Remove classname * [Python-experimental] types now classes, adds additionalProperties handling (#4154) * Changes python-experimental types to classes, adds additionalalproperties handling Adds model_utils update, updates model.mustache Updates api.mustache and uses model_to_dict in model_normal.mustache Updates requirements.mustache for PythonClientExperimental Passes through check_type when deserializing models Converts types from strings to classes in PythonClientExperimentalCodegen.java and PythonTest.java Creates PythonClientExperimentalTest.java Updates toInstantiationType to use ModelUtils.xxx Corrects docstring descriptions of response_type Updates python-experimental typing, partially fixes deserialization tests Adds fixes for some of the deserialization tests Fixes deserialization tests Switches model teplates to use allVars so allof props will be included Fixes tests.test_enum_arrays Fixes test_to_str Adds additional_properties_type, fixes teast_todict in test_map_test.py Correctly check the type of _request_timeout values Fixes test_upload_file test Turns off coercion when instantiating model types with client data Updates file handling to input and output an open file object Fixes linting errors Adds fixes for python2 tests, linting fixes Adds additionalproperties to docs + tests Regenerates python-experimatal client * Regenerates python-experimental client * Updates windows python-experimental bat file * Fixes addModelImport so client generation will work with the v2 spec * Reverts PythonClientCodegen.java * Acutally revert PythonClientCodegen.java * Updates the sample example for file_type in docs * Silences line too long error for python models so CI tests pass * Fixes handling of file uploads, adds tests for uploading files * Removes comment * Fixes mock installation in python2 * Limit mock addition to python-experimental test requirements only * Removes SmartBear copyright line * [Python] [Bug] Correct typo in the word datetime (#4304) * [Python] Remove redundant else statement (#4311) * [Python] Remove redundant else condition * Add indentation * Reduce extra indent * Avoid longer than 79 chars * Remove trailing space after response_body * [Python] Fix pep8 violation in imports * Revert "[Python] Fix pep8 violation in imports" This reverts commit bc69aaae7fa7739d0d48421e47a1a446f130c225. * [python][fix] Adding model summary to model documentation files (#4306) * feat(documentation): Adding model documentation * feat(documentation): Adding model documentation * feat(documentation): Adding model documentation * feat(documentation): Adding model documentation * Do not HTML escaped the description in the doc (#4321) * html escaped the description in the doc * update python oas3 sample * [Python] Avoid pep8 violation (#4316) * [python][metadata]: Adding license and author fields (#4318) * fix(license): Fixing the license and author information * fix(license): Fixing the license and author information * fix(metadata): Adding default values for contact details and license fields * fix(metadata): Adding default values for contact details and license fields * [Python-Experimental]: Remove redundant else statement (#4324) * [Python-Experimental]: Remove redundant else statement * Run petstore * [Python] [Performance] Avoid unnessacary checks inside the loop (#4305) * Fixes Python client Configuration class so each instance uses its own dicts (#4485) * Updates python and python-flask travis CI testing to use python 3.6, 3.7, and 3.8 (#4743) * fix package name in tox.ini (#4776) * [Python] Adds allOf/oneOf/anyOf composed models (#4446) * Adds composed model support for allOf oneOf anyOf * Moves discriminator into discriminator() class method, adds test_deserialize_lizard, adds setting discriminator using allOf schema * [Python] Remove mutable default argument (#4665) * [Python] Updates python test framework to pytest (#4765) * Switches python generators to use pytest, useNose CLI option added if to allow nose to be used instead * Adds ensure-up-to-date changes * Adds setup.cfg to python clients so we can configure nose when useNose=true * Adds fix for python-aiohttp testing, adds files missing from ensure-up-to-date * replace petstore_api with packageName (#4921) * [Python] Allow models to have properties of type self (#4888) * Refactors openapi_types into a staticmethod * Adds a Player model with a self type rpoperty, adds a test to ensure that it is working right * [Python] Conditionally set auth attributes (#4988) * Enhance python API keys * Run python scripts under ./bin/openapi3 * fix unit test issue * Fix unit tests * Fix unit tests * Invoke bin scripts * Add python-experimental-openapiv3-sample (#4992) Add python-experimental-openapiv3-sample Add missing files for the Python samples Add python-experimental-petstore.bat for openapi v3 Add python-experimental samples openapi v3 Add python-experimental samples openapi v3 Add python-experimental samples openapi v3. Address review comments add missing files for test purpose fix python formatting issues fix python formatting issues fix python formatting issues Fix unit tests fix python formatting issues fix python formatting issues fix python formatting issues fix 'line too long' pep8 error address PR comments for pep8 'line too long' problem regenerate samples execute samples scripts dummy commit to retrigger circleci Revert dummy commit, it didn't help. * Rebased to current upstream/master. (#4514) Tests for python client, comprising support for additional_properties and arrays. There are ugly workarounds for when there are discriminators, since the python client generator does not fully handle them. Cool indentation of test files. * [HttpBasicAuth] Use positive isBasicBasic tag instead of negative isBasicBearer (#5095) * use positive isBasicBasic tag instead of negative isBasicBearer * use positive isBasicBasic tag instead of negative isBasicBearer * [Python] Support for HTTP signature (#4958) * start implementation of HTTP signature * add api key parameters for http message signature * HTTP signature authentication * start implementation of HTTP signature * add api key parameters for http message signature * HTTP signature authentication * HTTP signature authentication * start implementation of HTTP signature * fix merge issues * Address formatting issues * Address formatting issues * move python-experimental-openapiv3-sample to a separate PR * Add support for HTTP signature * Add code comments * Add code comments * Fix formatting issues * Fix formatting issues * Fix formatting issues * add code comments * add code comments * fix python formatting issues * Make PKCS1v15 string constant consistent between Python and Golang * fix python formatting issues * Add code comments in generated Python. Start adding unit tests for HTTP signature * compliance with HTTP signature draft 12 * compliance with HTTP signature draft 12 * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * working on review comments * fix python formatting issues * fix trailing white space * address PR comments * address PR comments * address PR comments * Add suppport for '(expires)' signature parameter * address PR comments * address PR comments * Fix python formatting issues * Fix python formatting issues * Starting to move code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * Continue to refactor code to dedicated file for HTTP signatures * move method to ProcessUtils * conditionally build signing.py * move method to ProcessUtils * Code reformatting * externalize http signature configuration * address PR review comments * address PR review comments * run samples scripts * Address PR review comments * Move 'private_key' field to signing module * Move 'private_key' field to signing module * code cleanup * remove use of strftime('%s'), which is non portable * code cleanup * code cleanup * code cleanup * run sample scripts * Address PR review comments. * Add http-signature security scheme * Run sample scripts for go * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Fix issue uncovered in integration branch * Run samples scripts * move http signature tests to separate file * move http signature tests to separate file * unit tests for HTTP signature * continue implementation of unit tests * add http_signature_test to security scheme * add unit tests for http signature * address review comments * remove http signature from petapi * Add separate OAS file with support for HTTP signature * Add support for private key passphrase. Add more unit tests * Add unit test to validate the signature against the public key * remove http signature from petstore-with-fake-endpoints-models-for-testing.yaml * fix unit test issues * run scripts in bin directory * Refact unit test with better variable names * do not throw exception if security scheme is unrecognized * change URL of apache license to use https * sync from master * fix usage of escape character in python regex. Fix generated python documentation * write HTTP signed headers in user-specified order. Fix PEP8 formatting issues * write HTTP signed headers in user-specified order. Fix PEP8 formatting issues * http signature unit tests * Fix PEP8 format issue * spread out each requirement to a separate line * run samples scripts * run sample scripts * remove encoding of '+' character * [python] Cleanup ThreadPool with atexit rather than __del__ (#5094) * [python] Cleanup ThreadPool with atexit rather than __del__ This removes the `__del__` function from the generated Python client, and replaces it with a `cleanup` function. When a ThreadPool is created, the cleanup function is registered with the `atexit` module. This fixes #5093, where the API client could hang indefinitely at garbage collection. * Update petstore examples * Test to ensure threadpool is cleaned up * Docs now encourage using the context manager * Regenerate docs * Update samples * Switch to predominant use of appDescriptionWithNewLines in README.mustache (#5109) Descriptions tend to get lengthy and can include multiple lines. New lines are important to markdown formatting/syntax and can't just be ignored. Resolves https://github.com/OpenAPITools/openapi-generator/issues/3704 * [Python] Fix #5126 operations with req enums of length one (#5129) * Updates ap.mustache for python-experimental, adds test test_test_endpoint_enums_length_one * Removes sortParamsByRequiredFlag from python-experimental * Removes duplicate params from docstring * [Python] Python HTTP signature update (#5154) * improve python documentation and add import to __init__package.mustache * improve python documentation and add import to __init__package.mustache * add signing_info parameter conditionally * add code comments and remove 'Content-Length' header from example * Remove debug log statement * set access_token to None by default * set access_token to None by default * fix unit tests for Python experimental * fix trailing space * [python] use datetime aware object (#5209) * python use aware datetime object * python use aware datetime object * python use aware datetime object * python use aware datetime object * python use aware datetime object * python use aware datetime object * [Python] 5094 followup - Reduce redundancy in docs (#5161) * Reduce redundancy in python docs This is a followup to PR #5094, which had a few unresolved comments at merge time. This reduces the amount of redundant lines in the api example doc templates, and ensures that referenced Configuration objects are actually instantiated. * Regenerate samples * python: Add gitlab-ci.mustache (#5342) * python: Add gitlab-ci.mustache It does the same stuff as in the .travis.yml but just for Gitlab CI #5340 - Python .gitlab-ci.yml * python: Run all scripts in bin find bin/ -type f -name 'python*.sh' -exec {} \; Had to update all samples * Respect usenose for Python CI (#5376) * python: Respect useNose option in generated CI templates Travis and Gitlab CI now use nosetests or pytests depending on the "useNose" option that is passed. * python: Update CI samples They now respect the "useNose" option * [Python] add discard_unknown_keys parameter (#5362) * add discard_unknown_key parameter * add discard_unknown_key parameter * add discard_unknown_key parameter * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * discard unknown keys in composed schema if configuration.discard_unknown_keys is set * run sample scripts for python * code reformatting * execute script in bin directory * improve unit tests for discarding properties * [python] add method to set/get default configuration (#5315) * [python] add method to set/get default configuration * [python] change method name and fix handling api_key * python: using modified deepcopy to set/get default configuration * python: update samples * python: update samples * [python] Adds python oneOf/anyOf models + tests (#5341) * Adds oneOf + anyOf schemas, models and tests to python-experimental * Adds setUpClass and tearDownClass * Removes newline in method_init_shared.mustache * Regenerated v3 spec sample for python-experimental * Fxes test for discard_unknown_keys * Moves new models into existing spec, regen python-exp and go-exp * Also fix python-exp windows file * Add serialization of ModelComposed (#5551) * Fixes kwargs typos, removes E501s (#5552) * [python/asyncio] explicitly close client session via async context manager (#5621) * [Python-experimental] Documentation enhancement for oneOf schema and minor err msg improvement (#5791) * Add documentation to generated code * Improve error message * Improve documentation * Improve documentation * Improve documentation * Improve documentation * Improve documentation * Improve documentation * Run sample scripts * Address review comments * Address review comments * Fix problem in python error message * [Python-experimental] Use DER encoding for ECDSA signatures, add parameter to configure hash algorithm (#5924) * Use DER encoding for ECDSA signatures * Use DER encoding for ECDSA signatures * Use DER encoding for ECDSA signatures * Use DER encoding for ECDSA signatures * fix python unit tests for http message signature * Fix error message * format python code * format python code * [Python-experimental] Fix TypeError: unhashable type: 'list' (#5810) * handle scenario when value is a list, fix TypeError: unhashable type: 'list' * Add __hash__ function * use list instead of set * use list instead of set * use list instead of set * use list instead of set * use list instead of set * use list instead of set * [python/asyncio] fix passing proxy parameters to aiohttp (#5943) * Sync master to 5.0.x (#5968) * Change the Model template (#5222) * Add a link to Xero blog post (#5426) * Removal of Encoding in the Query-Params in order to prevent double Encoding. (#5255) This way letting WebClient do its Job in encoding the URL. * update java webclient sample * [kotlin][client] Add Jackson as serialization library (#5236) * [kotlin][client] Add Jackson as serialization library * [kotlin][client] Add kotlin-client-jackson.sh to kotlin-client-all.sh * update kotlin client samples * update doc Co-authored-by: William Cheng * include kotlin jackson in CI tests (#5438) * [Ruby] Add error output (#5428) * Add error output to the log so that we can make sure why the error occurred * Fix forbidden method invocation using default charsets * Update usage.md (#5443) * fix NPE for enum (#5445) * [Java][WebClient] better code format (#5433) * better code format for java webclient * prefix local varaible with localVar * fix issue with online service (#5461) * Support for additionalProperties in the C generator "Client: C" solves #5395 (#5440) * Support for additionalProperties in the C generator. * Support for additionalProperties in the C generator. * [docs] Enable Algolia search (#5472) * Fix #5420 add headers from configuration object (#5422) * Fix #5420 add headers from configuration object * Add baseOptions undefined checking #5420 * Update the samples and replace array to object #5420 * Update sample * [typescript] Clean up modelPropertyNaming across generators (#5427) * [typescript] Clean up modelPropertyNaming across generators Fixes https://github.com/OpenAPITools/openapi-generator/issues/2976 Generators without runtime models conversion use "original" property naming by default. It's still possible to change it via cli options Generators with runtime conversion keep using "camelCase" * Refactoring: use enum instead of string for modelPropertyNaming * Restore the original camelCase for var names, decouple it from property names * Swap toParamName and toVarName logic (looks like I've mistaken them) * Regenerate docs * Remove a no longer used private method * Added support for msvc builds in cpp-qt5-client generator (#5468) * Added support for msvc builds Moved GCC-specific compile flags to non msvc builds, and added equivalent flags for msvc. * CMakeLists condition cleanup * [all] Move feature set setter (#5460) When I originally implemented the feature set code, I added the getter/setter on DefaultCodegen and CodegenConfig as well as on GeneratorMetadata. GeneratorMetadata also includes the library variation features. When I went to add library-specific features, I realized the discrepancy. This removes the public setter from DefaultCodegen/CodegenConfig, and adds a protected modifyFeatureSet which accepts a lambda and hides the builder logic away in the method. This will be a breaking change for anyone who's created a custom generator in 4.2.3, so the impact is very limited. * [Swift5] small improvements to Objc compatibility (#5410) * [swift] make some small improvements * [swift][client] revert model to use allVars * PostProcessModelProperty with allVars * PostProcessModelProperty with vars * [swift] improve objc interoperability * [swift] fix swift4 for CI to pass * [swift] improve objc interoperability * [swift] improve objc interoperability * Swift - try to fix build * [swift] remove pods from git * [scala] [template] scala sttp client (#5429) * scala-sttp-client template * invoker for sttp fixed and tests added * clean up pet api test from redunant comments * docs updated * fix artefact name, model comments and redunant generic * code optimization * cross scala versions 2.11 2.12 2.13 * date serializers extracted and joda enabled as default * basic and bearer authorization added, apikey in query supported * [Ruby] Fix obsolete configuration of Rubocop and Rubocop's warns (#5417) (#5474) * fix obsolute configuration in generated .rubocop.yml * fix style of `expect` with block in generated ruby client's test code * update sample of ruby client * [scala] strip model class name for all scala generators (#5439) * stripped parameter enabled for all scala based generators * scala samples updated * docs generators updated * fix scalatra. regenerated by openapi3 script. manually removed enum default value from scalatra example due bug in schema extraction * [Scala][sttp] various improvements (#5475) * various improvements to scala sttp * update ScalaSttpClientCodegen.java * add windows batch file * test scala sttp in jdk8 * fix tempalte directory * Use the dataType if the baseType is not set (#5372) * Use the dataType if the baseType is not set * add tests for passing enum as parameter * updated requirements file in samples * Update spec to explicitly name objects and prevent `inline_object` * use the correct scripts to generate samples (`bin/openapi3/python-flask*`) * [python] Adds python oneOf/anyOf models + tests (#5341) * Adds oneOf + anyOf schemas, models and tests to python-experimental * Adds setUpClass and tearDownClass * Removes newline in method_init_shared.mustache * Regenerated v3 spec sample for python-experimental * Fxes test for discard_unknown_keys * Moves new models into existing spec, regen python-exp and go-exp * Also fix python-exp windows file * fix CVE-2020-8130 (#5483) * [go] Add Ptr method to const enum values (#5257) * fix rubocop warns in Ruby client's custom spec (#5488) * [C-libcurl] The name in API parameter should not be escaped even though it includes a C key word. (#5487) * [go-experimental] Support aliasing of API keys (#4940) * [go-experimental] Support aliasing of API keys * Use {{.}} inside condition * Use name instead of keyParamName for lookup * x-lookup to x-auth-id-alias * [java] Support aliasing of API keys (#4966) * [java] Support aliasing of API keys * Rebuild Java Jersey2 sample client * x-lookup to x-auth-id-alias * Regenerated * [cli][gradle] Validate now uses parseOptions w/setResolve (#5471) * [cli] Validate now uses parseOptions w/setResolve The validate command now uses ParseOptions#setResolve(true) to match how we parse in CodegenConfigurator and online's Generate. Without this option, the OpenAPI 3 parser skips the "resolve" block, which made lead to validations in the command not matching validations during generation. * [gradle] Validate now uses parseOptions w/setResolve The Graldle validate command now uses ParseOptions#setResolve(true) to match how we parse in CodegenConfigurator and online's Generate. Without this option, the OpenAPI 3 parser skips the "resolve" block, which made lead to validations in the command not matching validations during generation. * [kotlin]Fix ktor doesn't generate nullable types (#5258) * If not required, need `? = null` * run ./bin/kotlin-server-petstore.sh * Added `?` when value is `required` and `isNullable` * Rerun ./bin/kotlin-server-petstore.sh. But No differences * [C++] Add an option to allow having lowercase variables in models, Pistache: allow using reservedWords in models (#5434) * [C++][Pistache] Use reserved words to replace incorrect names discard old decision to truncate reservedWords * [C++][Pistache] Update struct model to use name instead of baseName * [C++][Pistache] Update Petstore sample * [C++] Add option to have lowercase variables * [C++] Update generated docs * [BUG] [JAVA | Spring] Cookie in parameter is not correctly generated (#5393) * Cookie in parameter is not correctly generated * gh-5386: Fix cookie parameter in * gh-5386: Fix cookie parameter in * gh-5386: Update test file * gh-5386: Fix cookie parameter in * gh-5386: Fix cookie parameter in * gh-5386: Regenerate samples * gh-5386: Fix test * Added Spring CookieValue tests Co-authored-by: Gonzalo * Add missing `@Generated` annotation. (#5384) The annotation is present on other generated files when using jaxrs-spec, but it missing on model classes. * [scala] [template] scala model property style (#5486) * Model property naming style generic for scala * scala templates based on abstractScala regererated * docs generators updated * property format tests * add Agoda as the user (#5494) * Hide timestamp in Scala Play server samples (#5495) * hide timestamp in scala play server output * add chameleon82 to scala tech committee * Add a link to tech blog tech.medpeer.co.jp (#5498) * Add links to blog posts about OpenAPI Generator (#5508) * Typescript array alias array (#4981) * Add failing tests for typescript type declaration * Refactor array and map child type string fallback * Add unaliasSchema to typescript getTypeDeclaration * TypeScriptRxjs: Use Blob as file type declaration This was inadvertantly changed in https://github.com/OpenAPITools/openapi-generator/pull/5266 * [core] Sanitize/underscore/camelize cache expiry (#5484) The helper methods for sanitize/underscore/camelize were recently updated to cache values in static maps. This would lead to a memory leak in hosted environments as the maps had no cleanup/expiry. This moves those cached entries to Caffeine caches with expiry based on last access to allow the edge-case performance improvement gains on very large documents, without the memory leak in hosted or embedded environments. * Update README.md * Add a link to the conference paper (#5510) * Add a link to the conference paper * fix author list * [Slim4] Add Data Mocker middleware (#4978) * [Slim4] Store response schemas * [Slim4] Add Data Mocker middleware * [Slim4] Enhance Slim router * [Slim4] Enhance config * [Slim4] Fix data format key in object mocking * [Slim4] Add tests for Data Mocker middleware * [Slim4] Add Mock feature documentation * [Slim4] Refresh samples * [Java][Spring][Spring-Cloud] Fix #5144 - Use conditional package declaration to avoid unnecessary dependencies (#5145) * FIX: Use conditional package declaration to avoid unnecessary dependencies * DEV: Adjusted sample ClientConfiguration.java for async spring-cloud * fix(php): no need to serialize collections, Guzzle does that, fix #2292 (#3984) * fix(php): only serialize collections if !explode, Guzzle handles the rest, fix #2292 * fix(php): update petstore samples Co-authored-by: Mahdi Dibaiee * [php] replace $collectionFormat with $style (#5517) * php - remove $collectionFormat * update php openapi3 petstore sample * [BUG][scala][template] scala generate java.math.BigDecimal instead of scala type (#5514) * [BUG] scala generate java.math.BigDecimal instead of scala type * update docs/generators * [PHP] complete support for form style (#5519) * [BUG][PHP] Parameter property style not fully implemented (related to comment on PR #3984) * [AUTOGENERATED][PHP] Sample Files * update jackson dependency to newer version (#5527) * Fix Swift4 CI tests (#5540) * comment out swift 4 order tests * comment out store tests * Test Dart petstore client in CircleCI (#5544) * test dart2 in circle ci (jdk7) * fix tests * update package * fix dart installation * Add serialization of ModelComposed (#5551) * Fixes kwargs typos, removes E501s (#5552) * Update generic model to support nullable properties (#5568) * [DOC] Add link to integration test wiki in CONTRIBUTING.md (#5570) * Add link to integration test wiki * Add link to integration test wiki * [Kotlin][client] fix file upload (#5548) * [kotlin] fix file upload * [kotlin] fix file upload * [kotlin] fix file upload * [kotlin][client] fix jackson integration * [kotlin] fix file upload * [kotlin] fix file upload * update doc * [Java] Fix exception when OAuth2 token URL is a relative URL (#5535) * Add support for case when OAuth2 token URL is a relative URL * Add support for case when OAuth2 token URL is a relative URL * run scripts under bin * [Java] fix runtime exception when there are multiple auth methods (#5530) * fix runtime exception when there are multiple auth methods * Refactor a bit so that it does not cause conflict with relative url token branch * [markdown] Fix broken links when generating markdown (#5569) * [markdown] Fix broken links when generating markdown The `api.mustache` file generates links to the markdown model files. These links were previously brokeen. Additionally, the defaultPackage for markdown is "/Models", so this looked pretty in the heading for model files. So this prefix has been stripped from the header in `model.mustache`. * Re-generate Petstore samples for markdown * typescript-angular: fix zone-js version for angular 8 (#5585) * Add a link to the slide (#5590) * [Swift] fix URLSession file upload (#5546) * [swift5] - fix URLSession file upload * [swift5] - fix URLSession file upload * [swift5] fix file upload * [swift5] - fix URLSession file upload * [swift] add unit tests for file upload * [swift] update samples copyright * [swift] add option for API prefix (#5567) * [swift] add option for API prefix * [swift] update docs * [haskell-http-client] update stack; exclude problem time versions (#5589) * [go-experimental] Do not generate HTTP signature unit test for every generated SDK (#5588) * Do not generate HTTP signature unit test for every generated SDK * Add golang 1.14 to CI environment * fix unit test issues * remove script commands that were commented out * add support for ed25519 private keys * PR to solve 2 open issues on enums: #5091 and #4293 (#5477) * PR to solve 2 open issues on enums: Issue 5091 needs to generate enums also when the enum is directly in a param to a API call, instead than in a model. I did that by copying and adapting enum code from *model* to *api* Issue 4293 needs to decorate enums, for when enum names or enum values are repeated over the yaml definition. * PR to solve 2 open issues on enums: Issue 5091 needs to generate enums also when the enum is directly in a param to a API call, instead than in a model. I did that by copying and adapting enum code from *model* to *api* Issue 4293 needs to decorate enums, for when enum names or enum values are repeated over the yaml definition. * Enums decorated: with {{projectName}}_{{classVarName}}_{{enumName}}_ in the models, with {{projectName}}_{{classVarName}}_{{enumName}}_ in the operations. * Changes to the c client: - Removed white space. - Removed ToJSON and FromJSON function for the enums, since they are not used - Sanitized project name in the .java file. For example, this solves a problem with the issue #2338, where the yaml file had title: "Skycoin REST API." * Changes to the c client: - Removed white space. - Removed ToJSON and FromJSON function for the enums, since they are not used - Sanitized project name in the .java file. For example, this solves a problem with the issue #2338, where the yaml file had title: "Skycoin REST API." * Adds parseFlattenSpec (#5526) * Adds parseFlattenSpec, updates tests and helper functions * Adds parseSPec invocation inside parseFlattenSpec * Scala-Akka: Add missing body to PATCH requests (#5605) * NodeJS - Adds missing keyword (#5606) * [jaxrs-cxf-cdi] Support PATCH httpMethod (#5574) Update the required CXF version to 3.1.2 since PATCH support appeared with this version. Add the cxf PATCH annotation to the imports so that the generated code when defining a PATCH api compiles. * fix default value for abstract scala and scalatra server impl (#5578) * [Java] Generated API class has wrong dataType and does not compile Issue (#5331) * add unit test assertion * add check for composed schema * add support for x-allOf-name * change x-allOf-name to x-all-of-name * Add more troubleshooting information * Add more troubleshooting information * Add more troubleshooting information * Add more troubleshooting information * [swift5] stop hiding network error (#5603) * [swift5] stop hiding network error * [swift5] stop hiding network error * [scala][templates] java 8 dates support (#5291) * [scala][akka-http-client] java8 dates support * scala-akka readme doc updated * DateSerializers renamed * rename serializers * move date-library option to abstractScala * generators docs updated * enum defined for date libraries * Backport to scala-http-client * fix scala-akka-client date serializers * fix typo in docs * switch scala templates to java8 (jsr-310) date library by default * update scala samples with java8 date library * update scala generators docs with java8 default date library * fix scala-play-server generator cli options as only java8 dateLibrary supported * fix scalaz DateTimeCodecs template to support java8 * scalaz ci test againt java7 removed as it generate scala 2.11.8 client which is java8 based * update doc * Adding Response Interceptor (#5500) * added Response interceptor for native clients * added Response interceptor for native clients * [k6] Add blog post about using the k6 generator (#5608) * [Kotlin] Remove kotlin-reflect dependency when not needed (#5502) * Remove kotlin-reflect dependency when using CodeGen * Update Kotlin tests * Regenerated unit test samples * Remove newline in generated build.gradle files * [typescript-fetch] add interfaces, withInterfaces (#5612) * typescript-fetch: interfaces, first draft * fix name in description * [scala] Regenerate akka sample (#5622) * scala-version 2.11.12 (#5618) * micheleISEP->michelealbano (#5625) * [Powershell] refactor the client generator (#5629) * add api client * add local variables * add configuration * add header/query/form parameter support * add partial header * add auth, fix parameters type * fix accept, content type * url query string * fix path, header * remove dep on C# client * fix method naming with package name * fix object * convert result from json * better response handling * remove tostring method * fix model doc * fix default module * generate api test files * better api, model tests * fix add pet * add appveyor * fix accept, content type * add petstore tests * fix form parameters * test delete * better file handling (upload) * better code sample * add package version, better doc * delete unused files * fix header parameters * clean up api client * update samples * support query parameter * better method and parameter naming * minor formatting change * better doc, fix cookie parameter * better doc * add api prefix support * better api nam prefix option * fix configuration * throw errors for required parameter * fix authentication * add try catch block to sample code * rename model * use debug, clean up comment * revise code * move bin script * update doc * add new file * better map support * [PowerShell] minor improvements and bug fixes (#5635) * add output type, minor format fix * minor test improvement * Port client updates to server (#5634) * Revert "scala-version 2.11.12 (#5618)" This reverts commit 6b984a926a0f99120a4ad80cef73bee19f8614cd. * update release date * Handle negative response from the server (#5649) * Fix integration tests (Travis, CircleCI) (#5672) * fix php tests * fix scala tests * update ts angular v6 rest * fix user create test * fix spring cloud test * comment out user delete * fix angular v7 tests * fix user test * fix tests * fix go exp tests * commented out delete user tests * comment out delete user tests in go openapi 3 * fix clojure tests * [PowerShell] Fixes typo (#5648) * Solving issue #5623 and supporting bools for C client label:"Client: C" (#5624) * Removed stray "printf"s in modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CLibcurlClientCodegen.java * Support for booleans in C client * Update README.md * Change to C API mustache files to solve issue #5623 * Debugging of C's modle-body.mustache, as suggested by ityuhui * Final changes suggested by ityuhui * [PowerShell] Fix map type (#5638) * fix map type * remove output type, fix appveyor * test macos * comment out failing scala test * fix typo: configuration * Revert "comment out failing scala test" This reverts commit 1dcf84ffcbb7ab520938ae7c75d60a8329f71478. * [powershell-experimental] Protects against stackoverflow when OAS spec has circular references (#5646) * protects against stackoverflow when OAS spec has circular references * protects against stackoverflow when OAS spec has circular references * Adds configuration option to skip certificate check. Fixes a typo. Fixes an issue which was restricting from cookie to get consumed (#5657) * [k6] bugfixes to improve the output script (#5614) * [k6] Skip appDescription escaping * [k6] Fix variable identifier in output * [k6] Fix bug with reserved words handling * [C][Client] Check the pointer before deleting operation to avoid core dump label:"Client C" (#5626) * [C-libcurl] Check the pointer before deleting operation to avoid core dump * [C-libcurl] Check the pointer before deleting operation, update sample * [kotlin][client] Add Jackson to interface properties and remove extra line feed (#5459) * [kotlin][client] Ensure Jackson annotations are consistent with interface vars * [kotlin][client] Rebuild samples * [kotlin][client] Some kotlin client enhancements - Don't use JsonFormat for Date objects, this should be controlled via a custom serializer/deserializer or a turning on and off serialization features of Jackson. I've updated the jacksonObjectMapper config to write the dates as strings, which I think was intended in the original commit. https://fasterxml.github.io/jackson-databind/javadoc/2.6/com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATES_AS_TIMESTAMPS https://fasterxml.github.io/jackson-databind/javadoc/2.6/com/fasterxml/jackson/databind/cfg/MapperConfig.html#getDateFormat-- - Dont' use @JsonFormat(shape = JsonFormat.Shape.OBJECT) for enums. This causes Enums to be formatted as objects with an internal "value" field. In reality, OpenAPI enums are just strings without properties and should be treated as a string. https://www.baeldung.com/jackson-serialize-enums#2-enum-as-json-object - Add's Kotlin use site annotation @get: to JsonProperty for parent interface properties. Otherwise Kotlin will warn: "This annotation is not applicable to target 'member property without backing field or delegate'" - Add's JsonTypeInfo annotations to interfaces for inheritance. This was copied verbatim from the kotlin-spring generator. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/kotlin-spring/typeInfoAnnotation.mustache * [kotlin][client] Rebuild kotlin samples * Remove scala version in parent pom (#5647) * [asciidoc] Allow the inclusion of additional documentation to t… (#5260) * [asccidoc] Allow the inclusion of additional documentation to the asccidoc generated Resolves #5228 * [jaxrs-reasteasy-eap] Fix invalid Bean Validation annotations for Longs (#5659) * fix issue #5658 * update samples * [PowerShell] Test powershell petstore client in Appveyor (#5674) * remove scala version in parent pom * test ps petstore in appveyor * fix command * build and import * fix import module * fix import * skip module import * run multiple commands * move to test script * test ps exit * fix exit * check last status code * clean tests * exit last code * add import * change dir * skip build failure * fix check * trigger build failure * fail fast * restore c# test * new line comment * add powershell exp to ensure up to date script * [PowerShell][Experimental] Better docstring (#5688) * add docstring to powershell module * add doc string * Nodejs express js packages update (#5675) * Updated to new nodejs packages, depending heavily on express-openapi-validator. Requires quite a change in code. Updated the business-logic in the controllers/Controller.js file. Logger now records also timestamp of events. Files are uploaded according to definition in config.js file * Removed commented-out code; Changed openApi document extensions to suit new express-openapi-validator definition; multipart and file uploading is supported now; Automatic response returns the values the were sent in the request * fixed README documentation, fixed a mistage in package.json/mustache * added generated files that were created when running the ./bin/test file * [go-experimental] Fix nullable support (#5414) * Fix nullable support in go-experimental client * Fix support for models with parents and container fields * Make sure that oneOf interfaces serialize properly even if they're required (non-pointers) on other models * Spaces => tabs * Regenerate samples * Make some methods of nullables pointer-receivers, add tests * Improve the Get/Set logic to make usage more convenient * Address review * [kotlin][client] make base path globally configurable (#5450) * [kotlin][client] make base path configurable * [kotlin][client] update pet project * [kotlin][client] set default base path * [kotlin][client] set default base path * [kotlin][client] set default base path * Add michelealbano to C technical committee (#5692) * [Go][Experimental] Rename extensions from x-basetype to x-go-base-type (#5691) * rename go vendor extension * update go exp petstore samples oas3 * comment out powershell petstore in uptodate script * remove processing of http_signature_test.mustache (#5696) * Fix generation of oneOf interfaces for oneOf usage in properties (#5400) * Fix generation of oneOf interfaces for oneOf usage in properties * Only generate oneOf interface models when oneOf is defined * use basic parsing (#5702) * [python/asyncio] explicitly close client session via async context manager (#5621) * [gradle] Include engine option for handlebars generation (#5686) * [codegen][Go] Fix compilation error of generated go code when schema is free form object (#5391) * Fix code generation for free-form objects in go-experimental * Execute scripts in bin directory * Add more use cases for open-ended types * Add more use cases for open-ended types * Add more use cases for open-ended types * add code comments * Better name for test properties * handle scenario when type is arbitrary * handle interface{} scenario * handle interface{} scenario * add helper function isAnyType * isAnyType function * implementation of isAnyType function * fix javadoc issue * handle interface{} scenario * use equals comparison instead of == * merge from master * Add code documentation * add code comments, remove unused min/max attribute, fix equals method * Handle 'anytype' use case * add code comments * override postProcessModelProperty to set vendor extension * Use vendorExtensions.x-golang-is-container * fix compilation error of generated code * fix compilation error of generated code * fix compilation error of generated code * [Java] Update version of maven-surefire-plugin (#5509) * use more recent version of maven-surefire-plugin * use more recent version of maven-surefire-plugin * higher debug level for troubleshooting ci issue * temporarily increase debug log to help troubleshoot * Use local instance of pet store service for unit test purpose * Add more logging to troubleshoot unit test failures * Add more logging to troubleshoot unit test failures * Add more logging to troubleshoot unit test failures * Add more logging to troubleshoot unit test failures * Add more logging to troubleshoot unit test failures * use random ID for Java unit test instead of fixed id * add code comments and specify URL for java unit test * reenable quiet argument * fix java unit test issues * fix java unit test issues * Revert "fix java unit test issues" This reverts commit e8508416ff0f2aeb568e3f916b013dc967390f74. * fix java unit test issues * Generator for JavaScript/Apollo Client (#5645) Co-authored-by: William Cheng * Add yutaka0m to Kotlin Technical Committee (#5716) * Add Scala client scripts to ensure-uptodate process (#5712) * add scala client to ensure-upto-date * new scala-akka petstore oas3 folder * regenerate scala akka oas2 petstore * remove script * Minor improvments to JS apollo generator (#5714) * minor improvments to js apollo generator * comment out apollo * [Rust Server] Handle text/xml correctly (#5660) * [Rust Server] Handle text/xml correctly Treat application/xml the same as text/xml as per RFC 7303 * [Rust Server] Add test for text/xml * Update samples * 4.3.0 release (#5721) * update samples (#5722) * 5211 - Use allVars instead of vars for Kotlin client (#5396) * [C++] [Qt5] fixed cpp-client-qt5 HttpRequestWorker requests crashing on timeout... (#5651) * - fixed cpp-client-qt5 HttpRequestWorker requests crashing on timeout when they have actually NOT timed out (were calling back into a deleted struct). * #minor fixes after review * Regenerate changed files Co-authored-by: valentin Bisson Co-authored-by: etherealjoy * Fix SSL setting in checkout script (#5725) * fix ssl setting in checkout script * add check for sbt-openapi-generator * [C] fix decode funtion (#5642) * fix function names and add parameter to return decoded bytes length from base64decode function * format base64decode function to avoid unnecessary malloc and fix wrong length assigning * update the pointer assigning for some reason var++ / *var++ cannot be done on int *var, hence making a local variable which is incremented and at the end it is assigned to the pointer. * Update bump.sh to go SNAPSHOT to version (#5727) * Fix CI failures (#5734) * update ci to use petstore 1.0.4 * comment out test * comment out test * comment out update user test * comment out more tests * use latest petstore * comment out updatePetWithForm * comment out update pet test * fix file path in release_version_update_docs (#5724) * better appveyor test (#5739) * better readme, type mapping, new option (#5740) * Remove warning for unused camel case vendor extension for Qt5 client and server (#5731) * [PS][Experimental] Add multiple server support (#5741) * code comment * add get host setting * add multiple server support * add default headers support (#5746) * [C][Client] Support SSL client authentication for the c client (#5719) * [C][Client] Support SSL client authentication * [C][Client] Support SSL client authentication, update sample * [kotlin] Fix #5247 incorrect enum parameter type for arrays (#5435) * [Erlang-Server] security definition context changes don't propagate to handler (#5751) * Map Merge Context & Params handler requires context and params to be merged before returned to user defined request_handler. * post build & shell script * Delete VERSION * [PS][PowerShell] fix passthru, use switch instead of bool (#5768) * fix passthru, use switch * remove line * comment out kotlin vertx server test (#5767) * add support for common verbs (#5771) * fix request.on_complete message when tempfile is nil (#5745) * fix request.on_complete message when tempfile is nil * update faraday client sample * add openapi3 client samples * use prepare instead of new (#5773) * use Initialize instead of prepare (#5777) * add map example (#5778) * [PS][Experimental] Better common verb handling (#5783) * better common verb handling * better debugging * add option to customize common verb * [cli][docker] Better expose version/sha information of builds (#5736) * [cli] Some CLI improvements… * Introduce --version * Introduce --help * Add --sha to version command for short SHA display * Output Version and SHA details * In new --version output, display repo and doc site Additional cleanup to suppress warnings and code quality. * [docker] Adds labels for metadata This adds image labels to store metadata on the online and cli docker images, using standard labels: * org.opencontainers.image.created * org.opencontainers.image.revision * org.opencontainers.image.title * org.opencontainers.image.version These can be inspected via 'docker inspect IMAGE_NAME' and may be useful in tooling/automation or bug reports submitted by users. For more details on these labels, see: https://github.com/opencontainers/image-spec/blob/master/annotations.md * Include version --full for equiv to --version * [cli] Add --global-property for -D replacement (#5687) -D option has been deprecated as it was previously used to: * Pass "system properties" * Pass additional properties This was confusing because we already have --additional-properties and because Java System Properties are passed as -D before program arguments. Confusion around the -D option had existed for some time, but when we introduced the thread-safe GlobalSettings to avoid overwriting Java System Properties, we created a hard break from Java System Properties in the generator. This also disconnected the previous "system properties" from accepting additional properties. Once these newly deprecated methods are removed, we will have a clear separation of concerns between: * Java System Properties * Global generator properties (used as workflow context) * Additional properties (used as generator options) This commit marks multiple places for cleanup in 5.0. These will be breaking changes, and lower effort to break in 5.0 with deprecation warnings now rather than adding sibling properties throughout the code and potentially introducing logic e… 0a40c736ada73c3c4dd2b0d6f90d4d0bd5248948 --- v1/APIErrorResponse/index.html | 2 +- v1/AWSAccount/index.html | 2 +- v1/AWSAccountAndLambdaRequest/index.html | 2 +- v1/AWSAccountCreateResponse/index.html | 2 +- v1/AWSAccountListResponse/index.html | 2 +- v1/AWSIntegrationApi/index.html | 2 +- v1/AWSLogsAsyncError/index.html | 2 +- v1/AWSLogsAsyncResponse/index.html | 2 +- v1/AWSLogsIntegrationApi/index.html | 2 +- v1/AWSLogsLambda/index.html | 2 +- v1/AWSLogsListResponse/index.html | 2 +- v1/AWSLogsListServicesResponse/index.html | 2 +- v1/AWSLogsServicesRequest/index.html | 2 +- v1/AWSNamespace/index.html | 2 +- v1/AWSTagFilter/index.html | 2 +- v1/AWSTagFilterCreateRequest/index.html | 2 +- v1/AWSTagFilterDeleteRequest/index.html | 2 +- v1/AWSTagFilterListResponse/index.html | 2 +- v1/AccessRole/index.html | 2 +- v1/AlertGraphWidgetDefinition/index.html | 2 +- v1/AlertGraphWidgetDefinitionType/index.html | 2 +- v1/AlertValueWidgetDefinition/index.html | 2 +- v1/AlertValueWidgetDefinitionType/index.html | 2 +- v1/ApiKey/index.html | 2 +- v1/ApiKeyListResponse/index.html | 2 +- v1/ApiKeyResponse/index.html | 2 +- v1/ApmStatsQueryColumnType/index.html | 2 +- v1/ApmStatsQueryDefinition/index.html | 2 +- v1/ApmStatsQueryRowType/index.html | 2 +- v1/ApplicationKey/index.html | 2 +- v1/ApplicationKeyListResponse/index.html | 2 +- v1/ApplicationKeyResponse/index.html | 2 +- v1/AuthenticationApi/index.html | 2 +- v1/AuthenticationValidationResponse/index.html | 2 +- v1/AzureAccount/index.html | 2 +- v1/AzureAccountListResponse/index.html | 2 +- v1/AzureIntegrationApi/index.html | 2 +- v1/CancelDowntimesByScopeRequest/index.html | 2 +- v1/CanceledDowntimesIds/index.html | 2 +- v1/ChangeWidgetDefinition/index.html | 2 +- v1/ChangeWidgetDefinitionType/index.html | 2 +- v1/ChangeWidgetRequest/index.html | 2 +- v1/CheckCanDeleteMonitorResponse/index.html | 2 +- v1/CheckCanDeleteMonitorResponseData/index.html | 2 +- v1/CheckCanDeleteSLOResponse/index.html | 2 +- v1/CheckCanDeleteSLOResponseData/index.html | 2 +- v1/CheckStatusWidgetDefinition/index.html | 2 +- v1/CheckStatusWidgetDefinitionType/index.html | 2 +- v1/Creator/index.html | 2 +- v1/Dashboard/index.html | 2 +- v1/DashboardDeleteResponse/index.html | 2 +- v1/DashboardLayoutType/index.html | 2 +- v1/DashboardList/index.html | 2 +- v1/DashboardListDeleteResponse/index.html | 2 +- v1/DashboardListListResponse/index.html | 2 +- v1/DashboardListsApi/index.html | 2 +- v1/DashboardSummary/index.html | 2 +- v1/DashboardSummaryDefinition/index.html | 2 +- v1/DashboardTemplateVariable/index.html | 2 +- v1/DashboardTemplateVariablePreset/index.html | 2 +- v1/DashboardTemplateVariablePresetValue/index.html | 2 +- v1/DashboardsApi/index.html | 2 +- v1/DeletedMonitor/index.html | 2 +- v1/DistributionWidgetDefinition/index.html | 2 +- v1/DistributionWidgetDefinitionType/index.html | 2 +- v1/DistributionWidgetRequest/index.html | 2 +- v1/Downtime/index.html | 2 +- v1/DowntimeRecurrence/index.html | 2 +- v1/DowntimesApi/index.html | 2 +- v1/Event/index.html | 2 +- v1/EventAlertType/index.html | 2 +- v1/EventListResponse/index.html | 2 +- v1/EventPriority/index.html | 2 +- v1/EventQueryDefinition/index.html | 2 +- v1/EventResponse/index.html | 2 +- v1/EventStreamWidgetDefinition/index.html | 2 +- v1/EventStreamWidgetDefinitionType/index.html | 2 +- v1/EventTimelineWidgetDefinition/index.html | 2 +- v1/EventTimelineWidgetDefinitionType/index.html | 2 +- v1/EventsApi/index.html | 2 +- v1/FormulaAndFunctionEventQueryDefinition/index.html | 2 +- v1/FormulaAndFunctionEventQueryDefinitionCompute/index.html | 2 +- v1/FormulaAndFunctionEventQueryDefinitionSearch/index.html | 2 +- v1/FormulaAndFunctionEventQueryGroupBy/index.html | 2 +- v1/FormulaAndFunctionEventQueryGroupBySort/index.html | 2 +- v1/FormulaAndFunctionEventsDataSource/index.html | 2 +- v1/FormulaAndFunctionMetricAggregation/index.html | 2 +- v1/FormulaAndFunctionMetricDataSource/index.html | 2 +- v1/FormulaAndFunctionMetricQueryDefinition/index.html | 2 +- v1/FormulaAndFunctionProcessQueryDataSource/index.html | 2 +- v1/FormulaAndFunctionProcessQueryDefinition/index.html | 2 +- v1/FormulaAndFunctionQueryDefinition/index.html | 2 +- v1/FormulaAndFunctionResponseFormat/index.html | 2 +- v1/FreeTextWidgetDefinition/index.html | 2 +- v1/FreeTextWidgetDefinitionType/index.html | 2 +- v1/GCPAccount/index.html | 2 +- v1/GCPAccountListResponse/index.html | 2 +- v1/GCPIntegrationApi/index.html | 2 +- v1/GeomapWidgetDefinition/index.html | 2 +- v1/GeomapWidgetDefinitionStyle/index.html | 2 +- v1/GeomapWidgetDefinitionType/index.html | 2 +- v1/GeomapWidgetDefinitionView/index.html | 2 +- v1/GeomapWidgetRequest/index.html | 2 +- v1/GraphSnapshot/index.html | 2 +- v1/GroupWidgetDefinition/index.html | 2 +- v1/GroupWidgetDefinitionType/index.html | 2 +- v1/HTTPMethod/index.html | 2 +- v1/HeatMapWidgetDefinition/index.html | 2 +- v1/HeatMapWidgetDefinitionType/index.html | 2 +- v1/HeatMapWidgetRequest/index.html | 2 +- v1/Host/index.html | 2 +- v1/HostListResponse/index.html | 2 +- v1/HostMapRequest/index.html | 2 +- v1/HostMapWidgetDefinition/index.html | 2 +- v1/HostMapWidgetDefinitionRequests/index.html | 2 +- v1/HostMapWidgetDefinitionStyle/index.html | 2 +- v1/HostMapWidgetDefinitionType/index.html | 2 +- v1/HostMeta/index.html | 2 +- v1/HostMetrics/index.html | 2 +- v1/HostMuteResponse/index.html | 2 +- v1/HostMuteSettings/index.html | 2 +- v1/HostTags/index.html | 2 +- v1/HostTotals/index.html | 2 +- v1/HostsApi/index.html | 2 +- v1/IFrameWidgetDefinition/index.html | 2 +- v1/IFrameWidgetDefinitionType/index.html | 2 +- v1/IPPrefixesAPI/index.html | 2 +- v1/IPPrefixesAPM/index.html | 2 +- v1/IPPrefixesAgents/index.html | 2 +- v1/IPPrefixesLogs/index.html | 2 +- v1/IPPrefixesProcess/index.html | 2 +- v1/IPPrefixesSynthetics/index.html | 2 +- v1/IPPrefixesWebhooks/index.html | 2 +- v1/IPRanges/index.html | 2 +- v1/IPRangesApi/index.html | 2 +- v1/IdpFormData/index.html | 2 +- v1/IdpResponse/index.html | 2 +- v1/ImageWidgetDefinition/index.html | 2 +- v1/ImageWidgetDefinitionType/index.html | 2 +- v1/KeyManagementApi/index.html | 2 +- v1/Log/index.html | 2 +- v1/LogContent/index.html | 2 +- v1/LogQueryDefinition/index.html | 2 +- v1/LogQueryDefinitionGroupBy/index.html | 2 +- v1/LogQueryDefinitionGroupBySort/index.html | 2 +- v1/LogQueryDefinitionSearch/index.html | 2 +- v1/LogStreamWidgetDefinition/index.html | 2 +- v1/LogStreamWidgetDefinitionType/index.html | 2 +- v1/LogsAPIError/index.html | 2 +- v1/LogsAPIErrorResponse/index.html | 2 +- v1/LogsApi/index.html | 2 +- v1/LogsArithmeticProcessor/index.html | 2 +- v1/LogsArithmeticProcessorType/index.html | 2 +- v1/LogsAttributeRemapper/index.html | 2 +- v1/LogsAttributeRemapperType/index.html | 2 +- v1/LogsCategoryProcessor/index.html | 2 +- v1/LogsCategoryProcessorCategory/index.html | 2 +- v1/LogsCategoryProcessorType/index.html | 2 +- v1/LogsDateRemapper/index.html | 2 +- v1/LogsDateRemapperType/index.html | 2 +- v1/LogsExclusion/index.html | 2 +- v1/LogsExclusionFilter/index.html | 2 +- v1/LogsFilter/index.html | 2 +- v1/LogsGeoIPParser/index.html | 2 +- v1/LogsGeoIPParserType/index.html | 2 +- v1/LogsGrokParser/index.html | 2 +- v1/LogsGrokParserRules/index.html | 2 +- v1/LogsGrokParserType/index.html | 2 +- v1/LogsIndex/index.html | 2 +- v1/LogsIndexListResponse/index.html | 2 +- v1/LogsIndexUpdateRequest/index.html | 2 +- v1/LogsIndexesApi/index.html | 2 +- v1/LogsIndexesOrder/index.html | 2 +- v1/LogsListRequest/index.html | 2 +- v1/LogsListRequestTime/index.html | 2 +- v1/LogsListResponse/index.html | 2 +- v1/LogsLookupProcessor/index.html | 2 +- v1/LogsLookupProcessorType/index.html | 2 +- v1/LogsMessageRemapper/index.html | 2 +- v1/LogsMessageRemapperType/index.html | 2 +- v1/LogsPipeline/index.html | 2 +- v1/LogsPipelineList/index.html | 2 +- v1/LogsPipelineProcessor/index.html | 2 +- v1/LogsPipelineProcessorType/index.html | 2 +- v1/LogsPipelinesApi/index.html | 2 +- v1/LogsPipelinesOrder/index.html | 2 +- v1/LogsProcessor/index.html | 2 +- v1/LogsQueryCompute/index.html | 2 +- v1/LogsServiceRemapper/index.html | 2 +- v1/LogsServiceRemapperType/index.html | 2 +- v1/LogsSort/index.html | 2 +- v1/LogsStatusRemapper/index.html | 2 +- v1/LogsStatusRemapperType/index.html | 2 +- v1/LogsStringBuilderProcessor/index.html | 2 +- v1/LogsStringBuilderProcessorType/index.html | 2 +- v1/LogsTraceRemapper/index.html | 2 +- v1/LogsTraceRemapperType/index.html | 2 +- v1/LogsURLParser/index.html | 2 +- v1/LogsURLParserType/index.html | 2 +- v1/LogsUserAgentParser/index.html | 2 +- v1/LogsUserAgentParserType/index.html | 2 +- v1/MetricMetadata/index.html | 2 +- v1/MetricSearchResponse/index.html | 2 +- v1/MetricSearchResponseResults/index.html | 2 +- v1/MetricsApi/index.html | 2 +- v1/MetricsListResponse/index.html | 2 +- v1/MetricsQueryMetadata/index.html | 2 +- v1/MetricsQueryResponse/index.html | 2 +- v1/MetricsQueryUnit/index.html | 2 +- v1/Monitor/index.html | 2 +- v1/MonitorDeviceID/index.html | 2 +- v1/MonitorOptions/index.html | 2 +- v1/MonitorOptionsAggregation/index.html | 2 +- v1/MonitorOverallStates/index.html | 2 +- v1/MonitorState/index.html | 2 +- v1/MonitorStateGroup/index.html | 2 +- v1/MonitorSummaryWidgetDefinition/index.html | 2 +- v1/MonitorSummaryWidgetDefinitionType/index.html | 2 +- v1/MonitorThresholdWindowOptions/index.html | 2 +- v1/MonitorThresholds/index.html | 2 +- v1/MonitorType/index.html | 2 +- v1/MonitorUpdateRequest/index.html | 2 +- v1/MonitorsApi/index.html | 2 +- v1/NoteWidgetDefinition/index.html | 2 +- v1/NoteWidgetDefinitionType/index.html | 2 +- v1/Organization/index.html | 2 +- v1/OrganizationBilling/index.html | 2 +- v1/OrganizationCreateBody/index.html | 2 +- v1/OrganizationCreateResponse/index.html | 2 +- v1/OrganizationListResponse/index.html | 2 +- v1/OrganizationResponse/index.html | 2 +- v1/OrganizationSettings/index.html | 2 +- v1/OrganizationSettingsSaml/index.html | 2 +- v1/OrganizationSettingsSamlAutocreateUsersDomains/index.html | 2 +- v1/OrganizationSettingsSamlIdpInitiatedLogin/index.html | 2 +- v1/OrganizationSettingsSamlStrictMode/index.html | 2 +- v1/OrganizationSubscription/index.html | 2 +- v1/OrganizationsApi/index.html | 2 +- v1/PagerDutyIntegrationApi/index.html | 2 +- v1/PagerDutyService/index.html | 2 +- v1/PagerDutyServiceKey/index.html | 2 +- v1/PagerDutyServiceName/index.html | 2 +- v1/Point/index.html | 2 +- v1/ProcessQueryDefinition/index.html | 2 +- v1/QuerySortOrder/index.html | 2 +- v1/QueryValueWidgetDefinition/index.html | 2 +- v1/QueryValueWidgetDefinitionType/index.html | 2 +- v1/QueryValueWidgetRequest/index.html | 2 +- v1/SLOBulkDelete/index.html | 2 +- v1/SLOBulkDeleteError/index.html | 2 +- v1/SLOBulkDeleteResponse/index.html | 2 +- v1/SLOBulkDeleteResponseData/index.html | 2 +- v1/SLOCorrection/index.html | 2 +- v1/SLOCorrectionCategory/index.html | 2 +- v1/SLOCorrectionCreateData/index.html | 2 +- v1/SLOCorrectionCreateRequest/index.html | 2 +- v1/SLOCorrectionCreateRequestAttributes/index.html | 2 +- v1/SLOCorrectionListResponse/index.html | 2 +- v1/SLOCorrectionResponse/index.html | 2 +- v1/SLOCorrectionResponseAttributes/index.html | 2 +- v1/SLOCorrectionType/index.html | 2 +- v1/SLOCorrectionUpdateData/index.html | 2 +- v1/SLOCorrectionUpdateRequest/index.html | 2 +- v1/SLOCorrectionUpdateRequestAttributes/index.html | 2 +- v1/SLODeleteResponse/index.html | 2 +- v1/SLOErrorBudgetRemainingData/index.html | 2 +- v1/SLOErrorTimeframe/index.html | 2 +- v1/SLOHistoryMetrics/index.html | 2 +- v1/SLOHistoryMetricsSeries/index.html | 2 +- v1/SLOHistoryMetricsSeriesMetadata/index.html | 2 +- v1/SLOHistoryMetricsSeriesMetadataUnit/index.html | 2 +- v1/SLOHistoryResponse/index.html | 2 +- v1/SLOHistoryResponseData/index.html | 2 +- v1/SLOHistoryResponseError/index.html | 2 +- v1/SLOHistorySLIData/index.html | 2 +- v1/SLOListResponse/index.html | 2 +- v1/SLOResponse/index.html | 2 +- v1/SLOThreshold/index.html | 2 +- v1/SLOTimeframe/index.html | 2 +- v1/SLOType/index.html | 2 +- v1/SLOTypeNumeric/index.html | 2 +- v1/SLOWidgetDefinition/index.html | 2 +- v1/SLOWidgetDefinitionType/index.html | 2 +- v1/ScatterPlotRequest/index.html | 2 +- v1/ScatterPlotWidgetDefinition/index.html | 2 +- v1/ScatterPlotWidgetDefinitionRequests/index.html | 2 +- v1/ScatterPlotWidgetDefinitionType/index.html | 2 +- v1/ServiceLevelObjective/index.html | 2 +- v1/ServiceLevelObjectiveCorrectionsApi/index.html | 2 +- v1/ServiceLevelObjectiveQuery/index.html | 2 +- v1/ServiceLevelObjectiveRequest/index.html | 2 +- v1/ServiceLevelObjectivesApi/index.html | 2 +- v1/ServiceMapWidgetDefinition/index.html | 2 +- v1/ServiceMapWidgetDefinitionType/index.html | 2 +- v1/ServiceSummaryWidgetDefinition/index.html | 2 +- v1/ServiceSummaryWidgetDefinitionType/index.html | 2 +- v1/SlackIntegrationApi/index.html | 2 +- v1/SlackIntegrationChannel/index.html | 2 +- v1/SlackIntegrationChannelDisplay/index.html | 2 +- v1/SlackIntegrationChannels/index.html | 2 +- v1/SnapshotsApi/index.html | 2 +- v1/SyntheticsAPIStep/index.html | 2 +- v1/SyntheticsAPIStepSubtype/index.html | 2 +- v1/SyntheticsAPITest/index.html | 2 +- v1/SyntheticsAPITestConfig/index.html | 2 +- v1/SyntheticsAPITestResultData/index.html | 2 +- v1/SyntheticsAPITestResultFull/index.html | 2 +- v1/SyntheticsAPITestResultFullCheck/index.html | 2 +- v1/SyntheticsAPITestResultShort/index.html | 2 +- v1/SyntheticsAPITestResultShortResult/index.html | 2 +- v1/SyntheticsAPITestType/index.html | 2 +- v1/SyntheticsAssertion/index.html | 2 +- v1/SyntheticsAssertionJSONPathOperator/index.html | 2 +- v1/SyntheticsAssertionJSONPathTarget/index.html | 2 +- v1/SyntheticsAssertionJSONPathTargetTarget/index.html | 2 +- v1/SyntheticsAssertionOperator/index.html | 2 +- v1/SyntheticsAssertionTarget/index.html | 2 +- v1/SyntheticsAssertionType/index.html | 2 +- v1/SyntheticsBasicAuth/index.html | 2 +- v1/SyntheticsBrowserError/index.html | 2 +- v1/SyntheticsBrowserErrorType/index.html | 2 +- v1/SyntheticsBrowserTestConfig/index.html | 2 +- v1/SyntheticsBrowserTestResultData/index.html | 2 +- v1/SyntheticsBrowserTestResultFull/index.html | 2 +- v1/SyntheticsBrowserTestResultFullCheck/index.html | 2 +- v1/SyntheticsBrowserTestResultShort/index.html | 2 +- v1/SyntheticsBrowserTestResultShortResult/index.html | 2 +- v1/SyntheticsBrowserTestType/index.html | 2 +- v1/SyntheticsBrowserVariable/index.html | 2 +- v1/SyntheticsBrowserVariableType/index.html | 2 +- v1/SyntheticsCITest/index.html | 2 +- v1/SyntheticsCITestBody/index.html | 2 +- v1/SyntheticsCITestMetadata/index.html | 2 +- v1/SyntheticsCITestMetadataCi/index.html | 2 +- v1/SyntheticsCITestMetadataGit/index.html | 2 +- v1/SyntheticsCheckType/index.html | 2 +- v1/SyntheticsConfigVariable/index.html | 2 +- v1/SyntheticsConfigVariableType/index.html | 2 +- v1/SyntheticsCoreWebVitals/index.html | 2 +- v1/SyntheticsDeleteTestsPayload/index.html | 2 +- v1/SyntheticsDeleteTestsResponse/index.html | 2 +- v1/SyntheticsDeletedTest/index.html | 2 +- v1/SyntheticsDevice/index.html | 2 +- v1/SyntheticsDeviceID/index.html | 2 +- v1/SyntheticsErrorCode/index.html | 2 +- v1/SyntheticsGetAPITestLatestResultsResponse/index.html | 2 +- v1/SyntheticsGetBrowserTestLatestResultsResponse/index.html | 2 +- v1/SyntheticsGlobalVariable/index.html | 2 +- v1/SyntheticsGlobalVariableParseTestOptions/index.html | 2 +- v1/SyntheticsGlobalVariableParseTestOptionsType/index.html | 2 +- v1/SyntheticsGlobalVariableParserType/index.html | 2 +- v1/SyntheticsGlobalVariableValue/index.html | 2 +- v1/SyntheticsListTestsResponse/index.html | 2 +- v1/SyntheticsLocation/index.html | 2 +- v1/SyntheticsLocations/index.html | 2 +- v1/SyntheticsParsingOptions/index.html | 2 +- v1/SyntheticsPlayingTab/index.html | 2 +- v1/SyntheticsPrivateLocation/index.html | 2 +- v1/SyntheticsPrivateLocationCreationResponse/index.html | 2 +- .../index.html | 2 +- v1/SyntheticsPrivateLocationSecrets/index.html | 2 +- v1/SyntheticsPrivateLocationSecretsAuthentication/index.html | 2 +- v1/SyntheticsPrivateLocationSecretsConfigDecryption/index.html | 2 +- v1/SyntheticsSSLCertificate/index.html | 2 +- v1/SyntheticsSSLCertificateIssuer/index.html | 2 +- v1/SyntheticsSSLCertificateSubject/index.html | 2 +- v1/SyntheticsStep/index.html | 2 +- v1/SyntheticsStepDetail/index.html | 2 +- v1/SyntheticsStepDetailWarning/index.html | 2 +- v1/SyntheticsStepType/index.html | 2 +- v1/SyntheticsTestConfig/index.html | 2 +- v1/SyntheticsTestDetails/index.html | 2 +- v1/SyntheticsTestDetailsSubType/index.html | 2 +- v1/SyntheticsTestDetailsType/index.html | 2 +- v1/SyntheticsTestHeaders/index.html | 2 +- v1/SyntheticsTestMonitorStatus/index.html | 2 +- v1/SyntheticsTestOptions/index.html | 2 +- v1/SyntheticsTestOptionsMonitorOptions/index.html | 2 +- v1/SyntheticsTestOptionsRetry/index.html | 2 +- v1/SyntheticsTestPauseStatus/index.html | 2 +- v1/SyntheticsTestProcessStatus/index.html | 2 +- v1/SyntheticsTestRequest/index.html | 2 +- v1/SyntheticsTestRequestCertificate/index.html | 2 +- v1/SyntheticsTestRequestCertificateItem/index.html | 2 +- v1/SyntheticsTickInterval/index.html | 2 +- v1/SyntheticsTiming/index.html | 2 +- v1/SyntheticsTriggerCITestLocation/index.html | 2 +- v1/SyntheticsTriggerCITestRunResult/index.html | 2 +- v1/SyntheticsTriggerCITestsResponse/index.html | 2 +- v1/SyntheticsUpdateTestPauseStatusPayload/index.html | 2 +- v1/SyntheticsVariableParser/index.html | 2 +- v1/SyntheticsWarningType/index.html | 2 +- v1/TableWidgetCellDisplayMode/index.html | 2 +- v1/TableWidgetDefinition/index.html | 2 +- v1/TableWidgetDefinitionType/index.html | 2 +- v1/TableWidgetHasSearchBar/index.html | 2 +- v1/TableWidgetRequest/index.html | 2 +- v1/TagToHosts/index.html | 2 +- v1/TagsApi/index.html | 2 +- v1/TargetFormatType/index.html | 2 +- v1/TimeseriesWidgetDefinition/index.html | 2 +- v1/TimeseriesWidgetDefinitionType/index.html | 2 +- v1/TimeseriesWidgetExpressionAlias/index.html | 2 +- v1/TimeseriesWidgetLegendColumn/index.html | 2 +- v1/TimeseriesWidgetLegendLayout/index.html | 2 +- v1/TimeseriesWidgetRequest/index.html | 2 +- v1/ToplistWidgetDefinition/index.html | 2 +- v1/ToplistWidgetDefinitionType/index.html | 2 +- v1/ToplistWidgetRequest/index.html | 2 +- v1/UsageAnalyzedLogsHour/index.html | 2 +- v1/UsageAnalyzedLogsResponse/index.html | 2 +- v1/UsageAttributionAggregates/index.html | 2 +- v1/UsageAttributionAggregatesBody/index.html | 2 +- v1/UsageAttributionBody/index.html | 2 +- v1/UsageAttributionMetadata/index.html | 2 +- v1/UsageAttributionPagination/index.html | 2 +- v1/UsageAttributionResponse/index.html | 2 +- v1/UsageAttributionSort/index.html | 2 +- v1/UsageAttributionTagNames/index.html | 2 +- v1/UsageAttributionValues/index.html | 2 +- v1/UsageBillableSummaryBody/index.html | 2 +- v1/UsageBillableSummaryHour/index.html | 2 +- v1/UsageBillableSummaryKeys/index.html | 2 +- v1/UsageBillableSummaryResponse/index.html | 2 +- v1/UsageCustomReportsAttributes/index.html | 2 +- v1/UsageCustomReportsData/index.html | 2 +- v1/UsageCustomReportsMeta/index.html | 2 +- v1/UsageCustomReportsPage/index.html | 2 +- v1/UsageCustomReportsResponse/index.html | 2 +- v1/UsageFargateHour/index.html | 2 +- v1/UsageFargateResponse/index.html | 2 +- v1/UsageHostHour/index.html | 2 +- v1/UsageHostsResponse/index.html | 2 +- v1/UsageIncidentManagementHour/index.html | 2 +- v1/UsageIncidentManagementResponse/index.html | 2 +- v1/UsageIndexedSpansHour/index.html | 2 +- v1/UsageIndexedSpansResponse/index.html | 2 +- v1/UsageIngestedSpansHour/index.html | 2 +- v1/UsageIngestedSpansResponse/index.html | 2 +- v1/UsageIoTHour/index.html | 2 +- v1/UsageIoTResponse/index.html | 2 +- v1/UsageLambdaHour/index.html | 2 +- v1/UsageLambdaResponse/index.html | 2 +- v1/UsageLogsByIndexHour/index.html | 2 +- v1/UsageLogsByIndexResponse/index.html | 2 +- v1/UsageLogsHour/index.html | 2 +- v1/UsageLogsResponse/index.html | 2 +- v1/UsageMeteringApi/index.html | 2 +- v1/UsageMetricCategory/index.html | 2 +- v1/UsageNetworkFlowsHour/index.html | 2 +- v1/UsageNetworkFlowsResponse/index.html | 2 +- v1/UsageNetworkHostsHour/index.html | 2 +- v1/UsageNetworkHostsResponse/index.html | 2 +- v1/UsageProfilingHour/index.html | 2 +- v1/UsageProfilingResponse/index.html | 2 +- v1/UsageReportsType/index.html | 2 +- v1/UsageRumSessionsHour/index.html | 2 +- v1/UsageRumSessionsResponse/index.html | 2 +- v1/UsageSNMPHour/index.html | 2 +- v1/UsageSNMPResponse/index.html | 2 +- v1/UsageSort/index.html | 2 +- v1/UsageSortDirection/index.html | 2 +- v1/UsageSpecifiedCustomReportsAttributes/index.html | 2 +- v1/UsageSpecifiedCustomReportsData/index.html | 2 +- v1/UsageSpecifiedCustomReportsMeta/index.html | 2 +- v1/UsageSpecifiedCustomReportsPage/index.html | 2 +- v1/UsageSpecifiedCustomReportsResponse/index.html | 2 +- v1/UsageSummaryDate/index.html | 2 +- v1/UsageSummaryDateOrg/index.html | 2 +- v1/UsageSummaryResponse/index.html | 2 +- v1/UsageSyntheticsAPIHour/index.html | 2 +- v1/UsageSyntheticsAPIResponse/index.html | 2 +- v1/UsageSyntheticsBrowserHour/index.html | 2 +- v1/UsageSyntheticsBrowserResponse/index.html | 2 +- v1/UsageSyntheticsHour/index.html | 2 +- v1/UsageSyntheticsResponse/index.html | 2 +- v1/UsageTimeseriesHour/index.html | 2 +- v1/UsageTimeseriesResponse/index.html | 2 +- v1/UsageTopAvgMetricsHour/index.html | 2 +- v1/UsageTopAvgMetricsResponse/index.html | 2 +- v1/UsageTraceHour/index.html | 2 +- v1/UsageTraceResponse/index.html | 2 +- v1/UsageTracingWithoutLimitsHour/index.html | 2 +- v1/UsageTracingWithoutLimitsResponse/index.html | 2 +- v1/User/index.html | 2 +- v1/UserDisableResponse/index.html | 2 +- v1/UserListResponse/index.html | 2 +- v1/UserResponse/index.html | 2 +- v1/UsersApi/index.html | 2 +- v1/Widget/index.html | 2 +- v1/WidgetAggregator/index.html | 2 +- v1/WidgetAxis/index.html | 2 +- v1/WidgetChangeType/index.html | 2 +- v1/WidgetColorPreference/index.html | 2 +- v1/WidgetComparator/index.html | 2 +- v1/WidgetCompareTo/index.html | 2 +- v1/WidgetConditionalFormat/index.html | 2 +- v1/WidgetCustomLink/index.html | 2 +- v1/WidgetDefinition/index.html | 2 +- v1/WidgetDisplayType/index.html | 2 +- v1/WidgetEvent/index.html | 2 +- v1/WidgetEventSize/index.html | 2 +- v1/WidgetFieldSort/index.html | 2 +- v1/WidgetFormula/index.html | 2 +- v1/WidgetFormulaLimit/index.html | 2 +- v1/WidgetGrouping/index.html | 2 +- v1/WidgetImageSizing/index.html | 2 +- v1/WidgetLayout/index.html | 2 +- v1/WidgetLayoutType/index.html | 2 +- v1/WidgetLineType/index.html | 2 +- v1/WidgetLineWidth/index.html | 2 +- v1/WidgetLiveSpan/index.html | 2 +- v1/WidgetMargin/index.html | 2 +- v1/WidgetMarker/index.html | 2 +- v1/WidgetMessageDisplay/index.html | 2 +- v1/WidgetMonitorSummaryDisplayFormat/index.html | 2 +- v1/WidgetMonitorSummarySort/index.html | 2 +- v1/WidgetNodeType/index.html | 2 +- v1/WidgetOrderBy/index.html | 2 +- v1/WidgetPalette/index.html | 2 +- v1/WidgetRequestStyle/index.html | 2 +- v1/WidgetServiceSummaryDisplayFormat/index.html | 2 +- v1/WidgetSizeFormat/index.html | 2 +- v1/WidgetSort/index.html | 2 +- v1/WidgetStyle/index.html | 2 +- v1/WidgetSummaryType/index.html | 2 +- v1/WidgetTextAlign/index.html | 2 +- v1/WidgetTickEdge/index.html | 2 +- v1/WidgetTime/index.html | 2 +- v1/WidgetTimeWindows/index.html | 2 +- v1/WidgetViewMode/index.html | 2 +- v1/WidgetVizType/index.html | 2 +- v2/APIErrorResponse/index.html | 2 +- v2/APIKeyCreateAttributes/index.html | 2 +- v2/APIKeyCreateData/index.html | 2 +- v2/APIKeyCreateRequest/index.html | 2 +- v2/APIKeyRelationships/index.html | 2 +- v2/APIKeyResponse/index.html | 2 +- v2/APIKeyResponseIncludedItem/index.html | 2 +- v2/APIKeyUpdateAttributes/index.html | 2 +- v2/APIKeyUpdateData/index.html | 2 +- v2/APIKeyUpdateRequest/index.html | 2 +- v2/APIKeysResponse/index.html | 2 +- v2/APIKeysSort/index.html | 2 +- v2/APIKeysType/index.html | 2 +- v2/ApplicationKeyCreateAttributes/index.html | 2 +- v2/ApplicationKeyCreateData/index.html | 2 +- v2/ApplicationKeyCreateRequest/index.html | 2 +- v2/ApplicationKeyRelationships/index.html | 2 +- v2/ApplicationKeyResponse/index.html | 2 +- v2/ApplicationKeyResponseIncludedItem/index.html | 2 +- v2/ApplicationKeyUpdateAttributes/index.html | 2 +- v2/ApplicationKeyUpdateData/index.html | 2 +- v2/ApplicationKeyUpdateRequest/index.html | 2 +- v2/ApplicationKeysSort/index.html | 2 +- v2/ApplicationKeysType/index.html | 2 +- v2/Creator/index.html | 2 +- v2/DashboardListAddItemsRequest/index.html | 2 +- v2/DashboardListAddItemsResponse/index.html | 2 +- v2/DashboardListDeleteItemsRequest/index.html | 2 +- v2/DashboardListDeleteItemsResponse/index.html | 2 +- v2/DashboardListItem/index.html | 2 +- v2/DashboardListItemRequest/index.html | 2 +- v2/DashboardListItemResponse/index.html | 2 +- v2/DashboardListItems/index.html | 2 +- v2/DashboardListUpdateItemsRequest/index.html | 2 +- v2/DashboardListUpdateItemsResponse/index.html | 2 +- v2/DashboardListsApi/index.html | 2 +- v2/DashboardType/index.html | 2 +- v2/FullAPIKey/index.html | 2 +- v2/FullAPIKeyAttributes/index.html | 2 +- v2/FullApplicationKey/index.html | 2 +- v2/FullApplicationKeyAttributes/index.html | 2 +- v2/IncidentCreateAttributes/index.html | 2 +- v2/IncidentCreateData/index.html | 2 +- v2/IncidentCreateRelationships/index.html | 2 +- v2/IncidentCreateRequest/index.html | 2 +- v2/IncidentFieldAttributes/index.html | 2 +- v2/IncidentFieldAttributesMultipleValue/index.html | 2 +- v2/IncidentFieldAttributesSingleValue/index.html | 2 +- v2/IncidentFieldAttributesSingleValueType/index.html | 2 +- v2/IncidentFieldAttributesValueType/index.html | 2 +- v2/IncidentIntegrationMetadataType/index.html | 2 +- v2/IncidentPostmortemType/index.html | 2 +- v2/IncidentRelatedObject/index.html | 2 +- v2/IncidentResponse/index.html | 2 +- v2/IncidentResponseAttributes/index.html | 2 +- v2/IncidentResponseData/index.html | 2 +- v2/IncidentResponseIncludedItem/index.html | 2 +- v2/IncidentResponseRelationships/index.html | 2 +- v2/IncidentServiceCreateAttributes/index.html | 2 +- v2/IncidentServiceCreateData/index.html | 2 +- v2/IncidentServiceCreateRequest/index.html | 2 +- v2/IncidentServiceIncludedItems/index.html | 2 +- v2/IncidentServiceRelationships/index.html | 2 +- v2/IncidentServiceResponse/index.html | 2 +- v2/IncidentServiceResponseAttributes/index.html | 2 +- v2/IncidentServiceResponseData/index.html | 2 +- v2/IncidentServiceType/index.html | 2 +- v2/IncidentServiceUpdateAttributes/index.html | 2 +- v2/IncidentServiceUpdateData/index.html | 2 +- v2/IncidentServiceUpdateRequest/index.html | 2 +- v2/IncidentServicesApi/index.html | 2 +- v2/IncidentServicesResponse/index.html | 2 +- v2/IncidentServicesResponseMeta/index.html | 2 +- v2/IncidentServicesResponseMetaPagination/index.html | 2 +- v2/IncidentTeamCreateAttributes/index.html | 2 +- v2/IncidentTeamCreateData/index.html | 2 +- v2/IncidentTeamCreateRequest/index.html | 2 +- v2/IncidentTeamIncludedItems/index.html | 2 +- v2/IncidentTeamRelationships/index.html | 2 +- v2/IncidentTeamResponse/index.html | 2 +- v2/IncidentTeamResponseAttributes/index.html | 2 +- v2/IncidentTeamResponseData/index.html | 2 +- v2/IncidentTeamType/index.html | 2 +- v2/IncidentTeamUpdateAttributes/index.html | 2 +- v2/IncidentTeamUpdateData/index.html | 2 +- v2/IncidentTeamUpdateRequest/index.html | 2 +- v2/IncidentTeamsApi/index.html | 2 +- v2/IncidentTeamsResponse/index.html | 2 +- v2/IncidentTimelineCellCreateAttributes/index.html | 2 +- v2/IncidentTimelineCellMarkdownContentType/index.html | 2 +- v2/IncidentTimelineCellMarkdownCreateAttributes/index.html | 2 +- .../index.html | 2 +- v2/IncidentType/index.html | 2 +- v2/IncidentUpdateAttributes/index.html | 2 +- v2/IncidentUpdateData/index.html | 2 +- v2/IncidentUpdateRelationships/index.html | 2 +- v2/IncidentUpdateRequest/index.html | 2 +- v2/IncidentsApi/index.html | 2 +- v2/IncidentsResponse/index.html | 2 +- v2/KeyManagementApi/index.html | 2 +- v2/ListApplicationKeysResponse/index.html | 2 +- v2/Log/index.html | 2 +- v2/LogAttributes/index.html | 2 +- v2/LogType/index.html | 2 +- v2/LogsAggregateBucket/index.html | 2 +- v2/LogsAggregateBucketValue/index.html | 2 +- v2/LogsAggregateBucketValueTimeseries/index.html | 2 +- v2/LogsAggregateBucketValueTimeseriesPoint/index.html | 2 +- v2/LogsAggregateRequest/index.html | 2 +- v2/LogsAggregateRequestPage/index.html | 2 +- v2/LogsAggregateResponse/index.html | 2 +- v2/LogsAggregateResponseData/index.html | 2 +- v2/LogsAggregateResponseStatus/index.html | 2 +- v2/LogsAggregateSort/index.html | 2 +- v2/LogsAggregateSortType/index.html | 2 +- v2/LogsAggregationFunction/index.html | 2 +- v2/LogsApi/index.html | 2 +- v2/LogsArchive/index.html | 2 +- v2/LogsArchiveAttributes/index.html | 2 +- v2/LogsArchiveCreateRequest/index.html | 2 +- v2/LogsArchiveCreateRequestAttributes/index.html | 2 +- v2/LogsArchiveCreateRequestDefinition/index.html | 2 +- v2/LogsArchiveCreateRequestDestination/index.html | 2 +- v2/LogsArchiveDefinition/index.html | 2 +- v2/LogsArchiveDestination/index.html | 2 +- v2/LogsArchiveDestinationAzure/index.html | 2 +- v2/LogsArchiveDestinationAzureType/index.html | 2 +- v2/LogsArchiveDestinationGCS/index.html | 2 +- v2/LogsArchiveDestinationGCSType/index.html | 2 +- v2/LogsArchiveDestinationS3/index.html | 2 +- v2/LogsArchiveDestinationS3Type/index.html | 2 +- v2/LogsArchiveIntegrationAzure/index.html | 2 +- v2/LogsArchiveIntegrationGCS/index.html | 2 +- v2/LogsArchiveIntegrationS3/index.html | 2 +- v2/LogsArchiveOrder/index.html | 2 +- v2/LogsArchiveOrderAttributes/index.html | 2 +- v2/LogsArchiveOrderDefinition/index.html | 2 +- v2/LogsArchiveOrderDefinitionType/index.html | 2 +- v2/LogsArchiveState/index.html | 2 +- v2/LogsArchives/index.html | 2 +- v2/LogsArchivesApi/index.html | 2 +- v2/LogsCompute/index.html | 2 +- v2/LogsComputeType/index.html | 2 +- v2/LogsGroupBy/index.html | 2 +- v2/LogsGroupByHistogram/index.html | 2 +- v2/LogsGroupByMissing/index.html | 2 +- v2/LogsGroupByTotal/index.html | 2 +- v2/LogsListRequest/index.html | 2 +- v2/LogsListRequestPage/index.html | 2 +- v2/LogsListResponse/index.html | 2 +- v2/LogsListResponseLinks/index.html | 2 +- v2/LogsMetricCompute/index.html | 2 +- v2/LogsMetricComputeAggregationType/index.html | 2 +- v2/LogsMetricCreateAttributes/index.html | 2 +- v2/LogsMetricCreateData/index.html | 2 +- v2/LogsMetricCreateRequest/index.html | 2 +- v2/LogsMetricFilter/index.html | 2 +- v2/LogsMetricGroupBy/index.html | 2 +- v2/LogsMetricResponse/index.html | 2 +- v2/LogsMetricResponseAttributes/index.html | 2 +- v2/LogsMetricResponseCompute/index.html | 2 +- v2/LogsMetricResponseComputeAggregationType/index.html | 2 +- v2/LogsMetricResponseData/index.html | 2 +- v2/LogsMetricResponseFilter/index.html | 2 +- v2/LogsMetricResponseGroupBy/index.html | 2 +- v2/LogsMetricType/index.html | 2 +- v2/LogsMetricUpdateAttributes/index.html | 2 +- v2/LogsMetricUpdateData/index.html | 2 +- v2/LogsMetricUpdateRequest/index.html | 2 +- v2/LogsMetricsApi/index.html | 2 +- v2/LogsMetricsResponse/index.html | 2 +- v2/LogsQueryFilter/index.html | 2 +- v2/LogsQueryOptions/index.html | 2 +- v2/LogsResponseMetadata/index.html | 2 +- v2/LogsResponseMetadataPage/index.html | 2 +- v2/LogsSort/index.html | 2 +- v2/LogsSortOrder/index.html | 2 +- v2/LogsWarning/index.html | 2 +- v2/Metric/index.html | 2 +- v2/MetricAllTags/index.html | 2 +- v2/MetricAllTagsAttributes/index.html | 2 +- v2/MetricAllTagsResponse/index.html | 2 +- v2/MetricDistinctVolume/index.html | 2 +- v2/MetricDistinctVolumeAttributes/index.html | 2 +- v2/MetricDistinctVolumeType/index.html | 2 +- v2/MetricIngestedIndexedVolume/index.html | 2 +- v2/MetricIngestedIndexedVolumeAttributes/index.html | 2 +- v2/MetricIngestedIndexedVolumeType/index.html | 2 +- v2/MetricTagConfiguration/index.html | 2 +- v2/MetricTagConfigurationAttributes/index.html | 2 +- v2/MetricTagConfigurationCreateAttributes/index.html | 2 +- v2/MetricTagConfigurationCreateData/index.html | 2 +- v2/MetricTagConfigurationCreateRequest/index.html | 2 +- v2/MetricTagConfigurationMetricTypes/index.html | 2 +- v2/MetricTagConfigurationResponse/index.html | 2 +- v2/MetricTagConfigurationType/index.html | 2 +- v2/MetricTagConfigurationUpdateAttributes/index.html | 2 +- v2/MetricTagConfigurationUpdateData/index.html | 2 +- v2/MetricTagConfigurationUpdateRequest/index.html | 2 +- v2/MetricType/index.html | 2 +- v2/MetricVolumes/index.html | 2 +- v2/MetricVolumesResponse/index.html | 2 +- v2/MetricsAndMetricTagConfigurations/index.html | 2 +- v2/MetricsAndMetricTagConfigurationsResponse/index.html | 2 +- v2/MetricsApi/index.html | 2 +- v2/Organization/index.html | 2 +- v2/OrganizationAttributes/index.html | 2 +- v2/OrganizationsType/index.html | 2 +- v2/Pagination/index.html | 2 +- v2/PartialAPIKey/index.html | 2 +- v2/PartialAPIKeyAttributes/index.html | 2 +- v2/PartialApplicationKey/index.html | 2 +- v2/PartialApplicationKeyAttributes/index.html | 2 +- v2/Permission/index.html | 2 +- v2/PermissionAttributes/index.html | 2 +- v2/PermissionsResponse/index.html | 2 +- v2/PermissionsType/index.html | 2 +- v2/ProcessSummariesMeta/index.html | 2 +- v2/ProcessSummariesMetaPage/index.html | 2 +- v2/ProcessSummariesResponse/index.html | 2 +- v2/ProcessSummary/index.html | 2 +- v2/ProcessSummaryAttributes/index.html | 2 +- v2/ProcessSummaryType/index.html | 2 +- v2/ProcessesApi/index.html | 2 +- v2/QuerySortOrder/index.html | 2 +- v2/RelationshipToIncidentIntegrationMetadataData/index.html | 2 +- v2/RelationshipToIncidentIntegrationMetadatas/index.html | 2 +- v2/RelationshipToIncidentPostmortem/index.html | 2 +- v2/RelationshipToIncidentPostmortemData/index.html | 2 +- v2/RelationshipToOrganization/index.html | 2 +- v2/RelationshipToOrganizationData/index.html | 2 +- v2/RelationshipToOrganizations/index.html | 2 +- v2/RelationshipToPermission/index.html | 2 +- v2/RelationshipToPermissionData/index.html | 2 +- v2/RelationshipToPermissions/index.html | 2 +- v2/RelationshipToRole/index.html | 2 +- v2/RelationshipToRoleData/index.html | 2 +- v2/RelationshipToRoles/index.html | 2 +- v2/RelationshipToUser/index.html | 2 +- v2/RelationshipToUserData/index.html | 2 +- v2/RelationshipToUsers/index.html | 2 +- v2/ResponseMetaAttributes/index.html | 2 +- v2/Role/index.html | 2 +- v2/RoleAttributes/index.html | 2 +- v2/RoleCreateAttributes/index.html | 2 +- v2/RoleCreateData/index.html | 2 +- v2/RoleCreateRequest/index.html | 2 +- v2/RoleCreateResponse/index.html | 2 +- v2/RoleCreateResponseData/index.html | 2 +- v2/RoleRelationships/index.html | 2 +- v2/RoleResponse/index.html | 2 +- v2/RoleResponseRelationships/index.html | 2 +- v2/RoleUpdateAttributes/index.html | 2 +- v2/RoleUpdateData/index.html | 2 +- v2/RoleUpdateRequest/index.html | 2 +- v2/RoleUpdateResponse/index.html | 2 +- v2/RoleUpdateResponseData/index.html | 2 +- v2/RolesApi/index.html | 2 +- v2/RolesResponse/index.html | 2 +- v2/RolesSort/index.html | 2 +- v2/RolesType/index.html | 2 +- v2/SecurityMonitoringApi/index.html | 2 +- v2/SecurityMonitoringFilter/index.html | 2 +- v2/SecurityMonitoringFilterAction/index.html | 2 +- v2/SecurityMonitoringListRulesResponse/index.html | 2 +- v2/SecurityMonitoringRuleCase/index.html | 2 +- v2/SecurityMonitoringRuleCaseCreate/index.html | 2 +- v2/SecurityMonitoringRuleCreatePayload/index.html | 2 +- v2/SecurityMonitoringRuleDetectionMethod/index.html | 2 +- v2/SecurityMonitoringRuleEvaluationWindow/index.html | 2 +- v2/SecurityMonitoringRuleKeepAlive/index.html | 2 +- v2/SecurityMonitoringRuleMaxSignalDuration/index.html | 2 +- v2/SecurityMonitoringRuleNewValueOptions/index.html | 2 +- v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/index.html | 2 +- .../index.html | 2 +- v2/SecurityMonitoringRuleOptions/index.html | 2 +- v2/SecurityMonitoringRuleQuery/index.html | 2 +- v2/SecurityMonitoringRuleQueryAggregation/index.html | 2 +- v2/SecurityMonitoringRuleQueryCreate/index.html | 2 +- v2/SecurityMonitoringRuleResponse/index.html | 2 +- v2/SecurityMonitoringRuleSeverity/index.html | 2 +- v2/SecurityMonitoringRuleUpdatePayload/index.html | 2 +- v2/SecurityMonitoringSignal/index.html | 2 +- v2/SecurityMonitoringSignalAttributes/index.html | 2 +- v2/SecurityMonitoringSignalListRequest/index.html | 2 +- v2/SecurityMonitoringSignalListRequestFilter/index.html | 2 +- v2/SecurityMonitoringSignalListRequestPage/index.html | 2 +- v2/SecurityMonitoringSignalType/index.html | 2 +- v2/SecurityMonitoringSignalsListResponse/index.html | 2 +- v2/SecurityMonitoringSignalsListResponseLinks/index.html | 2 +- v2/SecurityMonitoringSignalsListResponseMeta/index.html | 2 +- v2/SecurityMonitoringSignalsListResponseMetaPage/index.html | 2 +- v2/SecurityMonitoringSignalsSort/index.html | 2 +- v2/User/index.html | 2 +- v2/UserAttributes/index.html | 2 +- v2/UserCreateAttributes/index.html | 2 +- v2/UserCreateData/index.html | 2 +- v2/UserCreateRequest/index.html | 2 +- v2/UserInvitationData/index.html | 2 +- v2/UserInvitationDataAttributes/index.html | 2 +- v2/UserInvitationRelationships/index.html | 2 +- v2/UserInvitationResponse/index.html | 2 +- v2/UserInvitationResponseData/index.html | 2 +- v2/UserInvitationsRequest/index.html | 2 +- v2/UserInvitationsResponse/index.html | 2 +- v2/UserInvitationsType/index.html | 2 +- v2/UserRelationships/index.html | 2 +- v2/UserResponse/index.html | 2 +- v2/UserResponseIncludedItem/index.html | 2 +- v2/UserResponseRelationships/index.html | 2 +- v2/UserUpdateAttributes/index.html | 2 +- v2/UserUpdateData/index.html | 2 +- v2/UserUpdateRequest/index.html | 2 +- v2/UsersApi/index.html | 2 +- v2/UsersResponse/index.html | 2 +- v2/UsersType/index.html | 2 +- 848 files changed, 848 insertions(+), 848 deletions(-) diff --git a/v1/APIErrorResponse/index.html b/v1/APIErrorResponse/index.html index 818ce04415..31b3caaacf 100644 --- a/v1/APIErrorResponse/index.html +++ b/v1/APIErrorResponse/index.html @@ -1 +1 @@ - APIErrorResponse - Datadog API Client for Python
\ No newline at end of file + APIErrorResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSAccount/index.html b/v1/AWSAccount/index.html index c1fd9e6033..bb734efbe2 100644 --- a/v1/AWSAccount/index.html +++ b/v1/AWSAccount/index.html @@ -1 +1 @@ - AWSAccount - Datadog API Client for Python

AWSAccount

Returns the AWS account associated with this integration.

Properties

Name Type Description Notes
access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional]
account_id str Your AWS Account ID without dashes. [optional]
account_specific_namespace_rules {str: (bool,)} An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. [optional]
excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional]
filter_tags [str] The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1.,!region:us-east-1` [optional]
host_tags [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional]
role_name str Your Datadog role delegation name. [optional]
secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AWSAccount - Datadog API Client for Python

AWSAccount

Returns the AWS account associated with this integration.

Properties

Name Type Description Notes
access_key_id str Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. [optional]
account_id str Your AWS Account ID without dashes. [optional]
account_specific_namespace_rules {str: (bool,)} An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. [optional]
excluded_regions [str] An array of AWS regions to exclude from metrics collection. [optional]
filter_tags [str] The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1.,!region:us-east-1` [optional]
host_tags [str] Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. [optional]
role_name str Your Datadog role delegation name. [optional]
secret_access_key str Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSAccountAndLambdaRequest/index.html b/v1/AWSAccountAndLambdaRequest/index.html index 66e05f6c73..c65784ec66 100644 --- a/v1/AWSAccountAndLambdaRequest/index.html +++ b/v1/AWSAccountAndLambdaRequest/index.html @@ -1 +1 @@ - AWSAccountAndLambdaRequest - Datadog API Client for Python

AWSAccountAndLambdaRequest

AWS account ID and Lambda ARN.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes.
lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AWSAccountAndLambdaRequest - Datadog API Client for Python

AWSAccountAndLambdaRequest

AWS account ID and Lambda ARN.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes.
lambda_arn str ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSAccountCreateResponse/index.html b/v1/AWSAccountCreateResponse/index.html index d94be773cb..3d6ab63685 100644 --- a/v1/AWSAccountCreateResponse/index.html +++ b/v1/AWSAccountCreateResponse/index.html @@ -1 +1 @@ - AWSAccountCreateResponse - Datadog API Client for Python
\ No newline at end of file + AWSAccountCreateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSAccountListResponse/index.html b/v1/AWSAccountListResponse/index.html index 458bf497e6..b569770a34 100644 --- a/v1/AWSAccountListResponse/index.html +++ b/v1/AWSAccountListResponse/index.html @@ -1 +1 @@ - AWSAccountListResponse - Datadog API Client for Python
\ No newline at end of file + AWSAccountListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSIntegrationApi/index.html b/v1/AWSIntegrationApi/index.html index 6d8e13db9e..479b3aecb3 100644 --- a/v1/AWSIntegrationApi/index.html +++ b/v1/AWSIntegrationApi/index.html @@ -351,4 +351,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling AWSIntegrationApi->update_aws_account: %s\n" % e) -

Parameters

Name Type Description Notes
body AWSAccount AWS request object
account_id str Only return AWS accounts that matches this `account_id`. [optional]
role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional]
access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -
409 Conflict Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body AWSAccount AWS request object
account_id str Only return AWS accounts that matches this `account_id`. [optional]
role_name str Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. [optional]
access_key_id str Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. [optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -
409 Conflict Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSLogsAsyncError/index.html b/v1/AWSLogsAsyncError/index.html index a7df16281e..f4251d4550 100644 --- a/v1/AWSLogsAsyncError/index.html +++ b/v1/AWSLogsAsyncError/index.html @@ -1 +1 @@ - AWSLogsAsyncError - Datadog API Client for Python
\ No newline at end of file + AWSLogsAsyncError - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSLogsAsyncResponse/index.html b/v1/AWSLogsAsyncResponse/index.html index 63c13f7257..2351113922 100644 --- a/v1/AWSLogsAsyncResponse/index.html +++ b/v1/AWSLogsAsyncResponse/index.html @@ -1 +1 @@ - AWSLogsAsyncResponse - Datadog API Client for Python
\ No newline at end of file + AWSLogsAsyncResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSLogsIntegrationApi/index.html b/v1/AWSLogsIntegrationApi/index.html index c3ab6c8cc0..83dd20b27b 100644 --- a/v1/AWSLogsIntegrationApi/index.html +++ b/v1/AWSLogsIntegrationApi/index.html @@ -235,4 +235,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\n" % e) -

Parameters

This endpoint does not need any parameter.

Return type

[AWSLogsListServicesResponse]

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

This endpoint does not need any parameter.

Return type

[AWSLogsListServicesResponse]

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSLogsLambda/index.html b/v1/AWSLogsLambda/index.html index 9483689334..39a3f5aa8b 100644 --- a/v1/AWSLogsLambda/index.html +++ b/v1/AWSLogsLambda/index.html @@ -1 +1 @@ - AWSLogsLambda - Datadog API Client for Python
\ No newline at end of file + AWSLogsLambda - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSLogsListResponse/index.html b/v1/AWSLogsListResponse/index.html index 3c97ef91e3..917bba66df 100644 --- a/v1/AWSLogsListResponse/index.html +++ b/v1/AWSLogsListResponse/index.html @@ -1 +1 @@ - AWSLogsListResponse - Datadog API Client for Python

AWSLogsListResponse

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes. [optional]
lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional]
services [str] Array of services IDs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + AWSLogsListResponse - Datadog API Client for Python

AWSLogsListResponse

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes. [optional]
lambdas [AWSLogsLambda] List of ARNs configured in your Datadog account. [optional]
services [str] Array of services IDs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSLogsListServicesResponse/index.html b/v1/AWSLogsListServicesResponse/index.html index 57b202cc40..2708a78dc1 100644 --- a/v1/AWSLogsListServicesResponse/index.html +++ b/v1/AWSLogsListServicesResponse/index.html @@ -1 +1 @@ - AWSLogsListServicesResponse - Datadog API Client for Python

AWSLogsListServicesResponse

The list of current AWS services for which Datadog offers automatic log collection.

Properties

Name Type Description Notes
id str Key value in returned object. [optional]
label str Name of service available for configuration with Datadog logs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AWSLogsListServicesResponse - Datadog API Client for Python

AWSLogsListServicesResponse

The list of current AWS services for which Datadog offers automatic log collection.

Properties

Name Type Description Notes
id str Key value in returned object. [optional]
label str Name of service available for configuration with Datadog logs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSLogsServicesRequest/index.html b/v1/AWSLogsServicesRequest/index.html index 603793461e..9fb8796389 100644 --- a/v1/AWSLogsServicesRequest/index.html +++ b/v1/AWSLogsServicesRequest/index.html @@ -1 +1 @@ - AWSLogsServicesRequest - Datadog API Client for Python

AWSLogsServicesRequest

A list of current AWS services for which Datadog offers automatic log collection.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes.
services [str] Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AWSLogsServicesRequest - Datadog API Client for Python

AWSLogsServicesRequest

A list of current AWS services for which Datadog offers automatic log collection.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes.
services [str] Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSNamespace/index.html b/v1/AWSNamespace/index.html index 7dade4a55d..c8f65216f5 100644 --- a/v1/AWSNamespace/index.html +++ b/v1/AWSNamespace/index.html @@ -1 +1 @@ - AWSNamespace - Datadog API Client for Python

AWSNamespace

The namespace associated with the tag filter entry.

Properties

Name Type Description Notes
value str The namespace associated with the tag filter entry. must be one of ["elb", "application_elb", "sqs", "rds", "custom", "network_elb", "lambda", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 24, 2020
\ No newline at end of file + AWSNamespace - Datadog API Client for Python

AWSNamespace

The namespace associated with the tag filter entry.

Properties

Name Type Description Notes
value str The namespace associated with the tag filter entry. must be one of ["elb", "application_elb", "sqs", "rds", "custom", "network_elb", "lambda", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSTagFilter/index.html b/v1/AWSTagFilter/index.html index daaee01c71..0edc2eb0b0 100644 --- a/v1/AWSTagFilter/index.html +++ b/v1/AWSTagFilter/index.html @@ -1 +1 @@ - AWSTagFilter - Datadog API Client for Python
\ No newline at end of file + AWSTagFilter - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSTagFilterCreateRequest/index.html b/v1/AWSTagFilterCreateRequest/index.html index 5a5b2c3a5e..17335c53b2 100644 --- a/v1/AWSTagFilterCreateRequest/index.html +++ b/v1/AWSTagFilterCreateRequest/index.html @@ -1 +1 @@ - AWSTagFilterCreateRequest - Datadog API Client for Python

AWSTagFilterCreateRequest

The objects used to set an AWS tag filter.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes. [optional]
namespace AWSNamespace [optional]
tag_filter_str str The tag filter string. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 24, 2020
\ No newline at end of file + AWSTagFilterCreateRequest - Datadog API Client for Python

AWSTagFilterCreateRequest

The objects used to set an AWS tag filter.

Properties

Name Type Description Notes
account_id str Your AWS Account ID without dashes. [optional]
namespace AWSNamespace [optional]
tag_filter_str str The tag filter string. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AWSTagFilterDeleteRequest/index.html b/v1/AWSTagFilterDeleteRequest/index.html index 369271e862..efaab85cca 100644 --- a/v1/AWSTagFilterDeleteRequest/index.html +++ b/v1/AWSTagFilterDeleteRequest/index.html @@ -1 +1 @@ - AWSTagFilterDeleteRequest - Datadog API Client for Python
\ No newline at end of file + AWSTagFilterDeleteRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AWSTagFilterListResponse/index.html b/v1/AWSTagFilterListResponse/index.html index 2b24b350ff..15ef639e27 100644 --- a/v1/AWSTagFilterListResponse/index.html +++ b/v1/AWSTagFilterListResponse/index.html @@ -1 +1 @@ - AWSTagFilterListResponse - Datadog API Client for Python
\ No newline at end of file + AWSTagFilterListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AccessRole/index.html b/v1/AccessRole/index.html index 7587ddf101..7ca2aa61cd 100644 --- a/v1/AccessRole/index.html +++ b/v1/AccessRole/index.html @@ -1 +1 @@ - AccessRole - Datadog API Client for Python

AccessRole

The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).

Properties

Name Type Description Notes
value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to "st", must be one of ["st", "adm", "ro", "ERROR", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + AccessRole - Datadog API Client for Python

AccessRole

The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).

Properties

Name Type Description Notes
value str The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user). defaults to "st", must be one of ["st", "adm", "ro", "ERROR", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AlertGraphWidgetDefinition/index.html b/v1/AlertGraphWidgetDefinition/index.html index 0ce8ac2974..025c5af7a4 100644 --- a/v1/AlertGraphWidgetDefinition/index.html +++ b/v1/AlertGraphWidgetDefinition/index.html @@ -1 +1 @@ - AlertGraphWidgetDefinition - Datadog API Client for Python

AlertGraphWidgetDefinition

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

Properties

Name Type Description Notes
alert_id str ID of the alert to use in the widget.
type AlertGraphWidgetDefinitionType
viz_type WidgetVizType
time WidgetTime [optional]
title str The title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AlertGraphWidgetDefinition - Datadog API Client for Python

AlertGraphWidgetDefinition

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

Properties

Name Type Description Notes
alert_id str ID of the alert to use in the widget.
type AlertGraphWidgetDefinitionType
viz_type WidgetVizType
time WidgetTime [optional]
title str The title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AlertGraphWidgetDefinitionType/index.html b/v1/AlertGraphWidgetDefinitionType/index.html index 8aafb6e25f..a7935b242d 100644 --- a/v1/AlertGraphWidgetDefinitionType/index.html +++ b/v1/AlertGraphWidgetDefinitionType/index.html @@ -1 +1 @@ - AlertGraphWidgetDefinitionType - Datadog API Client for Python

AlertGraphWidgetDefinitionType

Type of the alert graph widget.

Properties

Name Type Description Notes
value str Type of the alert graph widget. defaults to "alert_graph", must be one of ["alert_graph", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + AlertGraphWidgetDefinitionType - Datadog API Client for Python

AlertGraphWidgetDefinitionType

Type of the alert graph widget.

Properties

Name Type Description Notes
value str Type of the alert graph widget. defaults to "alert_graph", must be one of ["alert_graph", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AlertValueWidgetDefinition/index.html b/v1/AlertValueWidgetDefinition/index.html index d8b8b5d05e..148f1e556b 100644 --- a/v1/AlertValueWidgetDefinition/index.html +++ b/v1/AlertValueWidgetDefinition/index.html @@ -1 +1 @@ - AlertValueWidgetDefinition - Datadog API Client for Python

AlertValueWidgetDefinition

Alert values are query values showing the current value of the metric in any monitor defined on your system.

Properties

Name Type Description Notes
alert_id str ID of the alert to use in the widget.
type AlertValueWidgetDefinitionType
precision int Number of decimal to show. If not defined, will use the raw value. [optional]
text_align WidgetTextAlign [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of value in the widget. [optional]
unit str Unit to display with the value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AlertValueWidgetDefinition - Datadog API Client for Python

AlertValueWidgetDefinition

Alert values are query values showing the current value of the metric in any monitor defined on your system.

Properties

Name Type Description Notes
alert_id str ID of the alert to use in the widget.
type AlertValueWidgetDefinitionType
precision int Number of decimal to show. If not defined, will use the raw value. [optional]
text_align WidgetTextAlign [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of value in the widget. [optional]
unit str Unit to display with the value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AlertValueWidgetDefinitionType/index.html b/v1/AlertValueWidgetDefinitionType/index.html index 444ec47c55..77778ca7ac 100644 --- a/v1/AlertValueWidgetDefinitionType/index.html +++ b/v1/AlertValueWidgetDefinitionType/index.html @@ -1 +1 @@ - AlertValueWidgetDefinitionType - Datadog API Client for Python

AlertValueWidgetDefinitionType

Type of the alert value widget.

Properties

Name Type Description Notes
value str Type of the alert value widget. defaults to "alert_value", must be one of ["alert_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + AlertValueWidgetDefinitionType - Datadog API Client for Python

AlertValueWidgetDefinitionType

Type of the alert value widget.

Properties

Name Type Description Notes
value str Type of the alert value widget. defaults to "alert_value", must be one of ["alert_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ApiKey/index.html b/v1/ApiKey/index.html index 49a33b26e5..6b216f1282 100644 --- a/v1/ApiKey/index.html +++ b/v1/ApiKey/index.html @@ -1 +1 @@ - ApiKey - Datadog API Client for Python

ApiKey

Datadog API key.

Properties

Name Type Description Notes
created str Date of creation of the API key. [optional][readonly]
created_by str Datadog user handle that created the API key. [optional][readonly]
key str API key. [optional][readonly]
name str Name of your API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ApiKey - Datadog API Client for Python

ApiKey

Datadog API key.

Properties

Name Type Description Notes
created str Date of creation of the API key. [optional][readonly]
created_by str Datadog user handle that created the API key. [optional][readonly]
key str API key. [optional][readonly]
name str Name of your API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ApiKeyListResponse/index.html b/v1/ApiKeyListResponse/index.html index 3640d740cf..cf5a90ffa3 100644 --- a/v1/ApiKeyListResponse/index.html +++ b/v1/ApiKeyListResponse/index.html @@ -1 +1 @@ - ApiKeyListResponse - Datadog API Client for Python
\ No newline at end of file + ApiKeyListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ApiKeyResponse/index.html b/v1/ApiKeyResponse/index.html index 3c81443729..40513bf4fd 100644 --- a/v1/ApiKeyResponse/index.html +++ b/v1/ApiKeyResponse/index.html @@ -1 +1 @@ - ApiKeyResponse - Datadog API Client for Python
\ No newline at end of file + ApiKeyResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ApmStatsQueryColumnType/index.html b/v1/ApmStatsQueryColumnType/index.html index 4c260d6294..7394a6504a 100644 --- a/v1/ApmStatsQueryColumnType/index.html +++ b/v1/ApmStatsQueryColumnType/index.html @@ -1 +1 @@ - ApmStatsQueryColumnType - Datadog API Client for Python
\ No newline at end of file + ApmStatsQueryColumnType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ApmStatsQueryDefinition/index.html b/v1/ApmStatsQueryDefinition/index.html index 8b10831c14..5e309f1596 100644 --- a/v1/ApmStatsQueryDefinition/index.html +++ b/v1/ApmStatsQueryDefinition/index.html @@ -1 +1 @@ - ApmStatsQueryDefinition - Datadog API Client for Python

ApmStatsQueryDefinition

The APM stats query for table and distributions widgets.

Properties

Name Type Description Notes
env str Environment name.
name str Operation name associated with service.
primary_tag str The organization's host group name and value.
row_type ApmStatsQueryRowType
service str Service name.
columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional]
resource str Resource name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 6, 2020
\ No newline at end of file + ApmStatsQueryDefinition - Datadog API Client for Python

ApmStatsQueryDefinition

The APM stats query for table and distributions widgets.

Properties

Name Type Description Notes
env str Environment name.
name str Operation name associated with service.
primary_tag str The organization's host group name and value.
row_type ApmStatsQueryRowType
service str Service name.
columns [ApmStatsQueryColumnType] Column properties used by the front end for display. [optional]
resource str Resource name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ApmStatsQueryRowType/index.html b/v1/ApmStatsQueryRowType/index.html index e67c889302..8f965d9730 100644 --- a/v1/ApmStatsQueryRowType/index.html +++ b/v1/ApmStatsQueryRowType/index.html @@ -1 +1 @@ - ApmStatsQueryRowType - Datadog API Client for Python

ApmStatsQueryRowType

The level of detail for the request.

Properties

Name Type Description Notes
value str The level of detail for the request. must be one of ["service", "resource", "span", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 29, 2020
\ No newline at end of file + ApmStatsQueryRowType - Datadog API Client for Python

ApmStatsQueryRowType

The level of detail for the request.

Properties

Name Type Description Notes
value str The level of detail for the request. must be one of ["service", "resource", "span", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ApplicationKey/index.html b/v1/ApplicationKey/index.html index cdddba75a9..ea40726d21 100644 --- a/v1/ApplicationKey/index.html +++ b/v1/ApplicationKey/index.html @@ -1 +1 @@ - ApplicationKey - Datadog API Client for Python

ApplicationKey

An application key with its associated metadata.

Properties

Name Type Description Notes
hash str Hash of an application key. [optional][readonly]
name str Name of an application key. [optional]
owner str Owner of an application key. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ApplicationKey - Datadog API Client for Python

ApplicationKey

An application key with its associated metadata.

Properties

Name Type Description Notes
hash str Hash of an application key. [optional][readonly]
name str Name of an application key. [optional]
owner str Owner of an application key. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ApplicationKeyListResponse/index.html b/v1/ApplicationKeyListResponse/index.html index 778e7b0f51..7ea4a46d74 100644 --- a/v1/ApplicationKeyListResponse/index.html +++ b/v1/ApplicationKeyListResponse/index.html @@ -1 +1 @@ - ApplicationKeyListResponse - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ApplicationKeyResponse/index.html b/v1/ApplicationKeyResponse/index.html index 63adc90bd1..47bb4685c7 100644 --- a/v1/ApplicationKeyResponse/index.html +++ b/v1/ApplicationKeyResponse/index.html @@ -1 +1 @@ - ApplicationKeyResponse - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AuthenticationApi/index.html b/v1/AuthenticationApi/index.html index 89e43c7cf0..fa834411e8 100644 --- a/v1/AuthenticationApi/index.html +++ b/v1/AuthenticationApi/index.html @@ -26,4 +26,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling AuthenticationApi->validate: %s\n" % e) -

Parameters

This endpoint does not need any parameter.

Return type

AuthenticationValidationResponse

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

This endpoint does not need any parameter.

Return type

AuthenticationValidationResponse

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AuthenticationValidationResponse/index.html b/v1/AuthenticationValidationResponse/index.html index d5b8f72fd7..db1ef65c6e 100644 --- a/v1/AuthenticationValidationResponse/index.html +++ b/v1/AuthenticationValidationResponse/index.html @@ -1 +1 @@ - AuthenticationValidationResponse - Datadog API Client for Python

AuthenticationValidationResponse

Represent validation endpoint responses.

Properties

Name Type Description Notes
valid bool Return `true` if the authentication response is valid. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AuthenticationValidationResponse - Datadog API Client for Python

AuthenticationValidationResponse

Represent validation endpoint responses.

Properties

Name Type Description Notes
valid bool Return `true` if the authentication response is valid. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AzureAccount/index.html b/v1/AzureAccount/index.html index 197d494a51..f3e6b45447 100644 --- a/v1/AzureAccount/index.html +++ b/v1/AzureAccount/index.html @@ -1 +1 @@ - AzureAccount - Datadog API Client for Python

AzureAccount

Datadog-Azure integrations configured for your organization.

Properties

Name Type Description Notes
client_id str Your Azure web application ID. [optional]
client_secret str Your Azure web application secret key. [optional]
errors [str] Errors in your configuration. [optional]
host_filters str Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. [optional]
new_client_id str Your New Azure web application ID. [optional]
new_tenant_name str Your New Azure Active Directory ID. [optional]
tenant_name str Your Azure Active Directory ID. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + AzureAccount - Datadog API Client for Python

AzureAccount

Datadog-Azure integrations configured for your organization.

Properties

Name Type Description Notes
client_id str Your Azure web application ID. [optional]
client_secret str Your Azure web application secret key. [optional]
errors [str] Errors in your configuration. [optional]
host_filters str Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. [optional]
new_client_id str Your New Azure web application ID. [optional]
new_tenant_name str Your New Azure Active Directory ID. [optional]
tenant_name str Your Azure Active Directory ID. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/AzureAccountListResponse/index.html b/v1/AzureAccountListResponse/index.html index 5aa7409fb9..58e30733b2 100644 --- a/v1/AzureAccountListResponse/index.html +++ b/v1/AzureAccountListResponse/index.html @@ -1 +1 @@ - AzureAccountListResponse - Datadog API Client for Python
\ No newline at end of file + AzureAccountListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/AzureIntegrationApi/index.html b/v1/AzureIntegrationApi/index.html index a641c7c8bb..e82ef4465b 100644 --- a/v1/AzureIntegrationApi/index.html +++ b/v1/AzureIntegrationApi/index.html @@ -189,4 +189,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling AzureIntegrationApi->update_azure_integration: %s\n" % e) -

Parameters

Name Type Description Notes
body AzureAccount Update a Datadog-Azure integration request body.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body AzureAccount Update a Datadog-Azure integration request body.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/CancelDowntimesByScopeRequest/index.html b/v1/CancelDowntimesByScopeRequest/index.html index f2d30ebdd9..40a3c3ed91 100644 --- a/v1/CancelDowntimesByScopeRequest/index.html +++ b/v1/CancelDowntimesByScopeRequest/index.html @@ -1 +1 @@ - CancelDowntimesByScopeRequest - Datadog API Client for Python

CancelDowntimesByScopeRequest

Cancel downtimes according to scope.

Properties

Name Type Description Notes
scope str The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` AND `env:prod`).

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + CancelDowntimesByScopeRequest - Datadog API Client for Python

CancelDowntimesByScopeRequest

Cancel downtimes according to scope.

Properties

Name Type Description Notes
scope str The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` AND `env:prod`).

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/CanceledDowntimesIds/index.html b/v1/CanceledDowntimesIds/index.html index af7646b5bd..48adfec158 100644 --- a/v1/CanceledDowntimesIds/index.html +++ b/v1/CanceledDowntimesIds/index.html @@ -1 +1 @@ - CanceledDowntimesIds - Datadog API Client for Python
\ No newline at end of file + CanceledDowntimesIds - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ChangeWidgetDefinition/index.html b/v1/ChangeWidgetDefinition/index.html index 6b2c9c520b..0c2e9370ed 100644 --- a/v1/ChangeWidgetDefinition/index.html +++ b/v1/ChangeWidgetDefinition/index.html @@ -1 +1 @@ - ChangeWidgetDefinition - Datadog API Client for Python

ChangeWidgetDefinition

The Change graph shows you the change in a value over the time period chosen.

Properties

Name Type Description Notes
requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`.
type ChangeWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ChangeWidgetDefinition - Datadog API Client for Python

ChangeWidgetDefinition

The Change graph shows you the change in a value over the time period chosen.

Properties

Name Type Description Notes
requests [ChangeWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`.
type ChangeWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ChangeWidgetDefinitionType/index.html b/v1/ChangeWidgetDefinitionType/index.html index 559d1091c1..a4e762075c 100644 --- a/v1/ChangeWidgetDefinitionType/index.html +++ b/v1/ChangeWidgetDefinitionType/index.html @@ -1 +1 @@ - ChangeWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + ChangeWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ChangeWidgetRequest/index.html b/v1/ChangeWidgetRequest/index.html index 2f48d32f4a..9316f4d49b 100644 --- a/v1/ChangeWidgetRequest/index.html +++ b/v1/ChangeWidgetRequest/index.html @@ -1 +1 @@ - ChangeWidgetRequest - Datadog API Client for Python

ChangeWidgetRequest

Updated change widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
change_type WidgetChangeType [optional]
compare_to WidgetCompareTo [optional]
event_query LogQueryDefinition [optional]
increase_good bool Whether to show increase as good. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
order_by WidgetOrderBy [optional]
order_dir WidgetSort [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
show_present bool Whether to show the present value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + ChangeWidgetRequest - Datadog API Client for Python

ChangeWidgetRequest

Updated change widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
change_type WidgetChangeType [optional]
compare_to WidgetCompareTo [optional]
event_query LogQueryDefinition [optional]
increase_good bool Whether to show increase as good. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
order_by WidgetOrderBy [optional]
order_dir WidgetSort [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
show_present bool Whether to show the present value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/CheckCanDeleteMonitorResponse/index.html b/v1/CheckCanDeleteMonitorResponse/index.html index 952400eb12..fd3e8b5ada 100644 --- a/v1/CheckCanDeleteMonitorResponse/index.html +++ b/v1/CheckCanDeleteMonitorResponse/index.html @@ -1 +1 @@ - CheckCanDeleteMonitorResponse - Datadog API Client for Python
\ No newline at end of file + CheckCanDeleteMonitorResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/CheckCanDeleteMonitorResponseData/index.html b/v1/CheckCanDeleteMonitorResponseData/index.html index f316fe3e4a..521afbcf2e 100644 --- a/v1/CheckCanDeleteMonitorResponseData/index.html +++ b/v1/CheckCanDeleteMonitorResponseData/index.html @@ -1 +1 @@ - CheckCanDeleteMonitorResponseData - Datadog API Client for Python

CheckCanDeleteMonitorResponseData

Wrapper object with the list of monitor IDs.

Properties

Name Type Description Notes
ok [int] An array of of Monitor IDs that can be safely deleted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + CheckCanDeleteMonitorResponseData - Datadog API Client for Python

CheckCanDeleteMonitorResponseData

Wrapper object with the list of monitor IDs.

Properties

Name Type Description Notes
ok [int] An array of of Monitor IDs that can be safely deleted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/CheckCanDeleteSLOResponse/index.html b/v1/CheckCanDeleteSLOResponse/index.html index 416cb5a94c..f57bb9410f 100644 --- a/v1/CheckCanDeleteSLOResponse/index.html +++ b/v1/CheckCanDeleteSLOResponse/index.html @@ -1 +1 @@ - CheckCanDeleteSLOResponse - Datadog API Client for Python
\ No newline at end of file + CheckCanDeleteSLOResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/CheckCanDeleteSLOResponseData/index.html b/v1/CheckCanDeleteSLOResponseData/index.html index f3887bf2d2..512781aae6 100644 --- a/v1/CheckCanDeleteSLOResponseData/index.html +++ b/v1/CheckCanDeleteSLOResponseData/index.html @@ -1 +1 @@ - CheckCanDeleteSLOResponseData - Datadog API Client for Python
\ No newline at end of file + CheckCanDeleteSLOResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/CheckStatusWidgetDefinition/index.html b/v1/CheckStatusWidgetDefinition/index.html index 4efffdfdc2..a2d71d048a 100644 --- a/v1/CheckStatusWidgetDefinition/index.html +++ b/v1/CheckStatusWidgetDefinition/index.html @@ -1 +1 @@ - CheckStatusWidgetDefinition - Datadog API Client for Python

CheckStatusWidgetDefinition

Check status shows the current status or number of results for any check performed.

Properties

Name Type Description Notes
check str Name of the check to use in the widget.
grouping WidgetGrouping
type CheckStatusWidgetDefinitionType
group str Group reporting a single check. [optional]
group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional]
tags [str] List of tags used to filter the groups reporting a cluster check. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + CheckStatusWidgetDefinition - Datadog API Client for Python

CheckStatusWidgetDefinition

Check status shows the current status or number of results for any check performed.

Properties

Name Type Description Notes
check str Name of the check to use in the widget.
grouping WidgetGrouping
type CheckStatusWidgetDefinitionType
group str Group reporting a single check. [optional]
group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional]
tags [str] List of tags used to filter the groups reporting a cluster check. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/CheckStatusWidgetDefinitionType/index.html b/v1/CheckStatusWidgetDefinitionType/index.html index 9ff40cb13d..41d40e3c5e 100644 --- a/v1/CheckStatusWidgetDefinitionType/index.html +++ b/v1/CheckStatusWidgetDefinitionType/index.html @@ -1 +1 @@ - CheckStatusWidgetDefinitionType - Datadog API Client for Python

CheckStatusWidgetDefinitionType

Type of the check status widget.

Properties

Name Type Description Notes
value str Type of the check status widget. defaults to "check_status", must be one of ["check_status", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + CheckStatusWidgetDefinitionType - Datadog API Client for Python

CheckStatusWidgetDefinitionType

Type of the check status widget.

Properties

Name Type Description Notes
value str Type of the check status widget. defaults to "check_status", must be one of ["check_status", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Creator/index.html b/v1/Creator/index.html index a99f20a305..32131931d0 100644 --- a/v1/Creator/index.html +++ b/v1/Creator/index.html @@ -1 +1 @@ - Creator - Datadog API Client for Python

Creator

Object describing the creator of the shared element.

Properties

Name Type Description Notes
email str Email of the creator. [optional]
handle str Handle of the creator. [optional]
name str Name of the creator. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + Creator - Datadog API Client for Python

Creator

Object describing the creator of the shared element.

Properties

Name Type Description Notes
email str Email of the creator. [optional]
handle str Handle of the creator. [optional]
name str Name of the creator. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Dashboard/index.html b/v1/Dashboard/index.html index e8a61b39b5..4c99a73256 100644 --- a/v1/Dashboard/index.html +++ b/v1/Dashboard/index.html @@ -1 +1 @@ - Dashboard - Datadog API Client for Python

Dashboard

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

Properties

Name Type Description Notes
layout_type DashboardLayoutType
title str Title of the dashboard.
widgets [Widget] List of widgets to display on the dashboard.
author_handle str Identifier of the dashboard author. [optional][readonly]
created_at datetime Creation date of the dashboard. [optional][readonly]
description str, none_type Description of the dashboard. [optional]
id str ID of the dashboard. [optional][readonly]
is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False
modified_at datetime Modification date of the dashboard. [optional][readonly]
notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional]
template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional]
template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional]
url str The URL of the dashboard. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + Dashboard - Datadog API Client for Python

Dashboard

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

Properties

Name Type Description Notes
layout_type DashboardLayoutType
title str Title of the dashboard.
widgets [Widget] List of widgets to display on the dashboard.
author_handle str Identifier of the dashboard author. [optional][readonly]
created_at datetime Creation date of the dashboard. [optional][readonly]
description str, none_type Description of the dashboard. [optional]
id str ID of the dashboard. [optional][readonly]
is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional] if omitted the server will use the default value of False
modified_at datetime Modification date of the dashboard. [optional][readonly]
notify_list [str], none_type List of handles of users to notify when changes are made to this dashboard. [optional]
template_variable_presets [DashboardTemplateVariablePreset], none_type Array of template variables saved views. [optional]
template_variables [DashboardTemplateVariable], none_type List of template variables for this dashboard. [optional]
url str The URL of the dashboard. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardDeleteResponse/index.html b/v1/DashboardDeleteResponse/index.html index a2c0a4c9a4..9f5eee8e85 100644 --- a/v1/DashboardDeleteResponse/index.html +++ b/v1/DashboardDeleteResponse/index.html @@ -1 +1 @@ - DashboardDeleteResponse - Datadog API Client for Python
\ No newline at end of file + DashboardDeleteResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardLayoutType/index.html b/v1/DashboardLayoutType/index.html index e792fbd154..e450cc4f57 100644 --- a/v1/DashboardLayoutType/index.html +++ b/v1/DashboardLayoutType/index.html @@ -1 +1 @@ - DashboardLayoutType - Datadog API Client for Python
\ No newline at end of file + DashboardLayoutType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardList/index.html b/v1/DashboardList/index.html index f6e01da3c5..f399a4e143 100644 --- a/v1/DashboardList/index.html +++ b/v1/DashboardList/index.html @@ -1 +1 @@ - DashboardList - Datadog API Client for Python

DashboardList

Your Datadog Dashboards.

Properties

Name Type Description Notes
name str The name of the dashboard list.
author Creator [optional]
created datetime Date of creation of the dashboard list. [optional][readonly]
dashboard_count int The number of dashboards in the list. [optional][readonly]
id int The ID of the dashboard list. [optional][readonly]
is_favorite bool Whether or not the list is in the favorites. [optional][readonly]
modified datetime Date of last edition of the dashboard list. [optional][readonly]
type str The type of dashboard list. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + DashboardList - Datadog API Client for Python

DashboardList

Your Datadog Dashboards.

Properties

Name Type Description Notes
name str The name of the dashboard list.
author Creator [optional]
created datetime Date of creation of the dashboard list. [optional][readonly]
dashboard_count int The number of dashboards in the list. [optional][readonly]
id int The ID of the dashboard list. [optional][readonly]
is_favorite bool Whether or not the list is in the favorites. [optional][readonly]
modified datetime Date of last edition of the dashboard list. [optional][readonly]
type str The type of dashboard list. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardListDeleteResponse/index.html b/v1/DashboardListDeleteResponse/index.html index 943630704a..1a59879983 100644 --- a/v1/DashboardListDeleteResponse/index.html +++ b/v1/DashboardListDeleteResponse/index.html @@ -1 +1 @@ - DashboardListDeleteResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListDeleteResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardListListResponse/index.html b/v1/DashboardListListResponse/index.html index 796387054a..57695592b6 100644 --- a/v1/DashboardListListResponse/index.html +++ b/v1/DashboardListListResponse/index.html @@ -1 +1 @@ - DashboardListListResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardListsApi/index.html b/v1/DashboardListsApi/index.html index d1b2a43086..39bf5dd966 100644 --- a/v1/DashboardListsApi/index.html +++ b/v1/DashboardListsApi/index.html @@ -184,4 +184,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling DashboardListsApi->update_dashboard_list: %s\n" % e) -

Parameters

Name Type Description Notes
list_id int ID of the dashboard list to update.
body DashboardList Update a dashboard list request body.

Return type

DashboardList

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
list_id int ID of the dashboard list to update.
body DashboardList Update a dashboard list request body.

Return type

DashboardList

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardSummary/index.html b/v1/DashboardSummary/index.html index b1e6c6f6fa..524c5ef918 100644 --- a/v1/DashboardSummary/index.html +++ b/v1/DashboardSummary/index.html @@ -1 +1 @@ - DashboardSummary - Datadog API Client for Python
\ No newline at end of file + DashboardSummary - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardSummaryDefinition/index.html b/v1/DashboardSummaryDefinition/index.html index 9facdb5a66..8396341006 100644 --- a/v1/DashboardSummaryDefinition/index.html +++ b/v1/DashboardSummaryDefinition/index.html @@ -1 +1 @@ - DashboardSummaryDefinition - Datadog API Client for Python

DashboardSummaryDefinition

Dashboard definition.

Properties

Name Type Description Notes
author_handle str Identifier of the dashboard author. [optional]
created_at datetime Creation date of the dashboard. [optional]
description str Description of the dashboard. [optional]
id str Dashboard identifier. [optional]
is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional]
layout_type DashboardLayoutType [optional]
modified_at datetime Modification date of the dashboard. [optional]
title str Title of the dashboard. [optional]
url str URL of the dashboard. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + DashboardSummaryDefinition - Datadog API Client for Python

DashboardSummaryDefinition

Dashboard definition.

Properties

Name Type Description Notes
author_handle str Identifier of the dashboard author. [optional]
created_at datetime Creation date of the dashboard. [optional]
description str Description of the dashboard. [optional]
id str Dashboard identifier. [optional]
is_read_only bool Whether this dashboard is read-only. If True, only the author and admins can make changes to it. [optional]
layout_type DashboardLayoutType [optional]
modified_at datetime Modification date of the dashboard. [optional]
title str Title of the dashboard. [optional]
url str URL of the dashboard. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardTemplateVariable/index.html b/v1/DashboardTemplateVariable/index.html index 70887c8f57..e0b6b7c642 100644 --- a/v1/DashboardTemplateVariable/index.html +++ b/v1/DashboardTemplateVariable/index.html @@ -1 +1 @@ - DashboardTemplateVariable - Datadog API Client for Python

DashboardTemplateVariable

Template variable.

Properties

Name Type Description Notes
name str The name of the variable.
default str, none_type The default value for the template variable on dashboard load. [optional]
prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + DashboardTemplateVariable - Datadog API Client for Python

DashboardTemplateVariable

Template variable.

Properties

Name Type Description Notes
name str The name of the variable.
default str, none_type The default value for the template variable on dashboard load. [optional]
prefix str, none_type The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardTemplateVariablePreset/index.html b/v1/DashboardTemplateVariablePreset/index.html index f3510f8583..4d3f41ee84 100644 --- a/v1/DashboardTemplateVariablePreset/index.html +++ b/v1/DashboardTemplateVariablePreset/index.html @@ -1 +1 @@ - DashboardTemplateVariablePreset - Datadog API Client for Python
\ No newline at end of file + DashboardTemplateVariablePreset - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DashboardTemplateVariablePresetValue/index.html b/v1/DashboardTemplateVariablePresetValue/index.html index ca3559d501..6bad9f99fe 100644 --- a/v1/DashboardTemplateVariablePresetValue/index.html +++ b/v1/DashboardTemplateVariablePresetValue/index.html @@ -1 +1 @@ - DashboardTemplateVariablePresetValue - Datadog API Client for Python

DashboardTemplateVariablePresetValue

Template variables saved views.

Properties

Name Type Description Notes
name str The name of the variable. [optional]
value str The value of the template variable within the saved view. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + DashboardTemplateVariablePresetValue - Datadog API Client for Python

DashboardTemplateVariablePresetValue

Template variables saved views.

Properties

Name Type Description Notes
name str The name of the variable. [optional]
value str The value of the template variable within the saved view. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DashboardsApi/index.html b/v1/DashboardsApi/index.html index 6b37ba05fc..a43a5669c9 100644 --- a/v1/DashboardsApi/index.html +++ b/v1/DashboardsApi/index.html @@ -222,4 +222,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->update_dashboard: %s\n" % e) -

Parameters

Name Type Description Notes
dashboard_id str The ID of the dashboard.
body Dashboard Update Dashboard request body.

Return type

Dashboard

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
dashboard_id str The ID of the dashboard.
body Dashboard Update Dashboard request body.

Return type

Dashboard

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DeletedMonitor/index.html b/v1/DeletedMonitor/index.html index e2cdcf15d0..ea17a1d2d9 100644 --- a/v1/DeletedMonitor/index.html +++ b/v1/DeletedMonitor/index.html @@ -1 +1 @@ - DeletedMonitor - Datadog API Client for Python
\ No newline at end of file + DeletedMonitor - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/DistributionWidgetDefinition/index.html b/v1/DistributionWidgetDefinition/index.html index ec0b37d27a..1452790c8f 100644 --- a/v1/DistributionWidgetDefinition/index.html +++ b/v1/DistributionWidgetDefinition/index.html @@ -1 +1 @@ - DistributionWidgetDefinition - Datadog API Client for Python

DistributionWidgetDefinition

The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.

Properties

Name Type Description Notes
requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`.
type DistributionWidgetDefinitionType
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool Whether or not to display the legend on this widget. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + DistributionWidgetDefinition - Datadog API Client for Python

DistributionWidgetDefinition

The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.

Properties

Name Type Description Notes
requests [DistributionWidgetRequest] Array of one request object to display in the widget. See the dedicated Request JSON schema documentation to learn how to build the `REQUEST_SCHEMA`.
type DistributionWidgetDefinitionType
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool Whether or not to display the legend on this widget. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DistributionWidgetDefinitionType/index.html b/v1/DistributionWidgetDefinitionType/index.html index 9637c26d82..1d86d0073f 100644 --- a/v1/DistributionWidgetDefinitionType/index.html +++ b/v1/DistributionWidgetDefinitionType/index.html @@ -1 +1 @@ - DistributionWidgetDefinitionType - Datadog API Client for Python

DistributionWidgetDefinitionType

Type of the distribution widget.

Properties

Name Type Description Notes
value str Type of the distribution widget. defaults to "distribution", must be one of ["distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + DistributionWidgetDefinitionType - Datadog API Client for Python

DistributionWidgetDefinitionType

Type of the distribution widget.

Properties

Name Type Description Notes
value str Type of the distribution widget. defaults to "distribution", must be one of ["distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DistributionWidgetRequest/index.html b/v1/DistributionWidgetRequest/index.html index 201263b28a..f7dd66ab60 100644 --- a/v1/DistributionWidgetRequest/index.html +++ b/v1/DistributionWidgetRequest/index.html @@ -1 +1 @@ - DistributionWidgetRequest - Datadog API Client for Python

DistributionWidgetRequest

Updated distribution widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + DistributionWidgetRequest - Datadog API Client for Python

DistributionWidgetRequest

Updated distribution widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Downtime/index.html b/v1/Downtime/index.html index e9c3881ffb..cf28729275 100644 --- a/v1/Downtime/index.html +++ b/v1/Downtime/index.html @@ -1 +1 @@ - Downtime - Datadog API Client for Python

Downtime

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

Properties

Name Type Description Notes
active bool If a scheduled downtime currently exists. [optional][readonly]
canceled int, none_type If a scheduled downtime is canceled. [optional][readonly]
creator_id int User ID of the downtime creator. [optional][readonly]
disabled bool If a downtime has been disabled. [optional]
downtime_type int `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. [optional][readonly]
end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional]
id int The downtime ID. [optional][readonly]
message str A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. [optional]
monitor_id int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional]
monitor_tags [str] A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` AND `team:frontend`. [optional]
parent_id int, none_type ID of the parent Downtime. [optional]
recurrence DowntimeRecurrence [optional]
scope [str] The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` AND `env:prod`). [optional]
start int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional]
timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional]
updater_id int, none_type ID of the last user that updated the downtime. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 8, 2020
\ No newline at end of file + Downtime - Datadog API Client for Python

Downtime

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

Properties

Name Type Description Notes
active bool If a scheduled downtime currently exists. [optional][readonly]
canceled int, none_type If a scheduled downtime is canceled. [optional][readonly]
creator_id int User ID of the downtime creator. [optional][readonly]
disabled bool If a downtime has been disabled. [optional]
downtime_type int `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. [optional][readonly]
end int, none_type POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. [optional]
id int The downtime ID. [optional][readonly]
message str A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. [optional]
monitor_id int, none_type A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. [optional]
monitor_tags [str] A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` AND `team:frontend`. [optional]
parent_id int, none_type ID of the parent Downtime. [optional]
recurrence DowntimeRecurrence [optional]
scope [str] The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` AND `env:prod`). [optional]
start int POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. [optional]
timezone str The timezone in which to display the downtime's start and end times in Datadog applications. [optional]
updater_id int, none_type ID of the last user that updated the downtime. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DowntimeRecurrence/index.html b/v1/DowntimeRecurrence/index.html index 67138f6e6e..954cbab127 100644 --- a/v1/DowntimeRecurrence/index.html +++ b/v1/DowntimeRecurrence/index.html @@ -1 +1 @@ - DowntimeRecurrence - Datadog API Client for Python

DowntimeRecurrence

An object defining the recurrence of the downtime.

Properties

Name Type Description Notes
period int How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`. [optional]
rrule str The `RRULE` standard for defining recurring events (requires to set \"type\" to rrule) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the iCalendar Spec are supported. Note: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional]
type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional]
until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional]
until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional]
week_days [str] A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file + DowntimeRecurrence - Datadog API Client for Python

DowntimeRecurrence

An object defining the recurrence of the downtime.

Properties

Name Type Description Notes
period int How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`. [optional]
rrule str The `RRULE` standard for defining recurring events (requires to set \"type\" to rrule) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the iCalendar Spec are supported. Note: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this downtime guide [optional]
type str The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. [optional]
until_date int, none_type The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. [optional]
until_occurrences int, none_type How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. [optional]
week_days [str] A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/DowntimesApi/index.html b/v1/DowntimesApi/index.html index ba95429a04..77823a75a0 100644 --- a/v1/DowntimesApi/index.html +++ b/v1/DowntimesApi/index.html @@ -241,4 +241,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling DowntimesApi->update_downtime: %s\n" % e) -

Parameters

Name Type Description Notes
downtime_id int ID of the downtime to update.
body Downtime Update a downtime request body.

Return type

Downtime

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Downtime not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
downtime_id int ID of the downtime to update.
body Downtime Update a downtime request body.

Return type

Downtime

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Downtime not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Event/index.html b/v1/Event/index.html index ce08b196ce..2c81d29ab2 100644 --- a/v1/Event/index.html +++ b/v1/Event/index.html @@ -1 +1 @@ - Event - Datadog API Client for Python

Event

Object representing an event.

Properties

Name Type Description Notes
alert_type EventAlertType [optional]
date_happened int POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. [optional]
device_name str A device name. [optional]
host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional]
id int Integer ID of the event. [optional][readonly]
payload str Payload of the event. [optional][readonly]
priority EventPriority [optional]
source_type_name str The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values available here. [optional]
tags [str] A list of tags to apply to the event. [optional]
text str The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. Use `msg_text` with the Datadog Ruby library. [optional]
title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional]
url str URL of the event. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 22, 2020
\ No newline at end of file + Event - Datadog API Client for Python

Event

Object representing an event.

Properties

Name Type Description Notes
alert_type EventAlertType [optional]
date_happened int POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. [optional]
device_name str A device name. [optional]
host str Host name to associate with the event. Any tags associated with the host are also applied to this event. [optional]
id int Integer ID of the event. [optional][readonly]
payload str Payload of the event. [optional][readonly]
priority EventPriority [optional]
source_type_name str The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values available here. [optional]
tags [str] A list of tags to apply to the event. [optional]
text str The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. Use `msg_text` with the Datadog Ruby library. [optional]
title str The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. [optional]
url str URL of the event. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventAlertType/index.html b/v1/EventAlertType/index.html index ca11e30ef5..00b3ea5822 100644 --- a/v1/EventAlertType/index.html +++ b/v1/EventAlertType/index.html @@ -1 +1 @@ - EventAlertType - Datadog API Client for Python

EventAlertType

If an alert event is enabled, set its type. For example, error, warning, info, success, user_update, recommendation, and snapshot.

Properties

Name Type Description Notes
value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of ["error", "warning", "info", "success", "user_update", "recommendation", "snapshot", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 20, 2020
\ No newline at end of file + EventAlertType - Datadog API Client for Python

EventAlertType

If an alert event is enabled, set its type. For example, error, warning, info, success, user_update, recommendation, and snapshot.

Properties

Name Type Description Notes
value str If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. must be one of ["error", "warning", "info", "success", "user_update", "recommendation", "snapshot", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventListResponse/index.html b/v1/EventListResponse/index.html index bc20d9fe4e..34044b228b 100644 --- a/v1/EventListResponse/index.html +++ b/v1/EventListResponse/index.html @@ -1 +1 @@ - EventListResponse - Datadog API Client for Python
\ No newline at end of file + EventListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/EventPriority/index.html b/v1/EventPriority/index.html index 270d7dcd88..93014a258e 100644 --- a/v1/EventPriority/index.html +++ b/v1/EventPriority/index.html @@ -1 +1 @@ - EventPriority - Datadog API Client for Python

EventPriority

The priority of the event. For example, normal or low.

Properties

Name Type Description Notes
value str The priority of the event. For example, `normal` or `low`. must be one of ["normal", "low", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + EventPriority - Datadog API Client for Python

EventPriority

The priority of the event. For example, normal or low.

Properties

Name Type Description Notes
value str The priority of the event. For example, `normal` or `low`. must be one of ["normal", "low", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventQueryDefinition/index.html b/v1/EventQueryDefinition/index.html index 8dac2ffde1..121173cb4d 100644 --- a/v1/EventQueryDefinition/index.html +++ b/v1/EventQueryDefinition/index.html @@ -1 +1 @@ - EventQueryDefinition - Datadog API Client for Python

EventQueryDefinition

The event query.

Properties

Name Type Description Notes
search str The query being made on the event.
tags_execution str The execution method for multi-value filters. Can be either and or or.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + EventQueryDefinition - Datadog API Client for Python

EventQueryDefinition

The event query.

Properties

Name Type Description Notes
search str The query being made on the event.
tags_execution str The execution method for multi-value filters. Can be either and or or.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventResponse/index.html b/v1/EventResponse/index.html index 8f11751292..eb14baee49 100644 --- a/v1/EventResponse/index.html +++ b/v1/EventResponse/index.html @@ -1 +1 @@ - EventResponse - Datadog API Client for Python
\ No newline at end of file + EventResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/EventStreamWidgetDefinition/index.html b/v1/EventStreamWidgetDefinition/index.html index 6b6da86a6a..386436a9de 100644 --- a/v1/EventStreamWidgetDefinition/index.html +++ b/v1/EventStreamWidgetDefinition/index.html @@ -1 +1 @@ - EventStreamWidgetDefinition - Datadog API Client for Python

EventStreamWidgetDefinition

The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the event stream with.
type EventStreamWidgetDefinitionType
event_size WidgetEventSize [optional]
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + EventStreamWidgetDefinition - Datadog API Client for Python

EventStreamWidgetDefinition

The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the event stream with.
type EventStreamWidgetDefinitionType
event_size WidgetEventSize [optional]
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventStreamWidgetDefinitionType/index.html b/v1/EventStreamWidgetDefinitionType/index.html index 0e8a30c555..48fe80f715 100644 --- a/v1/EventStreamWidgetDefinitionType/index.html +++ b/v1/EventStreamWidgetDefinitionType/index.html @@ -1 +1 @@ - EventStreamWidgetDefinitionType - Datadog API Client for Python

EventStreamWidgetDefinitionType

Type of the event stream widget.

Properties

Name Type Description Notes
value str Type of the event stream widget. defaults to "event_stream", must be one of ["event_stream", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + EventStreamWidgetDefinitionType - Datadog API Client for Python

EventStreamWidgetDefinitionType

Type of the event stream widget.

Properties

Name Type Description Notes
value str Type of the event stream widget. defaults to "event_stream", must be one of ["event_stream", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventTimelineWidgetDefinition/index.html b/v1/EventTimelineWidgetDefinition/index.html index aafb6085c4..e415492c55 100644 --- a/v1/EventTimelineWidgetDefinition/index.html +++ b/v1/EventTimelineWidgetDefinition/index.html @@ -1 +1 @@ - EventTimelineWidgetDefinition - Datadog API Client for Python

EventTimelineWidgetDefinition

The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the event timeline with.
type EventTimelineWidgetDefinitionType
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + EventTimelineWidgetDefinition - Datadog API Client for Python

EventTimelineWidgetDefinition

The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the event timeline with.
type EventTimelineWidgetDefinitionType
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventTimelineWidgetDefinitionType/index.html b/v1/EventTimelineWidgetDefinitionType/index.html index 674ef1aa39..9502d7e58c 100644 --- a/v1/EventTimelineWidgetDefinitionType/index.html +++ b/v1/EventTimelineWidgetDefinitionType/index.html @@ -1 +1 @@ - EventTimelineWidgetDefinitionType - Datadog API Client for Python

EventTimelineWidgetDefinitionType

Type of the event timeline widget.

Properties

Name Type Description Notes
value str Type of the event timeline widget. defaults to "event_timeline", must be one of ["event_timeline", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + EventTimelineWidgetDefinitionType - Datadog API Client for Python

EventTimelineWidgetDefinitionType

Type of the event timeline widget.

Properties

Name Type Description Notes
value str Type of the event timeline widget. defaults to "event_timeline", must be one of ["event_timeline", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/EventsApi/index.html b/v1/EventsApi/index.html index 05a8947631..c9b30c1268 100644 --- a/v1/EventsApi/index.html +++ b/v1/EventsApi/index.html @@ -76,4 +76,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling EventsApi->list_events: %s\n" % e) -

Parameters

Name Type Description Notes
start int POSIX timestamp.
end int POSIX timestamp.
priority EventPriority Priority of your events, either `low` or `normal`. [optional]
sources str A comma separated string of sources. [optional]
tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional]
unaggregated bool Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. [optional]

Return type

EventListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
start int POSIX timestamp.
end int POSIX timestamp.
priority EventPriority Priority of your events, either `low` or `normal`. [optional]
sources str A comma separated string of sources. [optional]
tags str A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. [optional]
unaggregated bool Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. [optional]

Return type

EventListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventQueryDefinition/index.html b/v1/FormulaAndFunctionEventQueryDefinition/index.html index 4c7398e2e6..5c5771ce7c 100644 --- a/v1/FormulaAndFunctionEventQueryDefinition/index.html +++ b/v1/FormulaAndFunctionEventQueryDefinition/index.html @@ -1 +1 @@ - FormulaAndFunctionEventQueryDefinition - Datadog API Client for Python

FormulaAndFunctionEventQueryDefinition

A formula and functions events query.

Properties

Name Type Description Notes
compute FormulaAndFunctionEventQueryDefinitionCompute
data_source FormulaAndFunctionEventsDataSource
name str Name of the query for use in formulas.
group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional]
indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional]
search FormulaAndFunctionEventQueryDefinitionSearch [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + FormulaAndFunctionEventQueryDefinition - Datadog API Client for Python

FormulaAndFunctionEventQueryDefinition

A formula and functions events query.

Properties

Name Type Description Notes
compute FormulaAndFunctionEventQueryDefinitionCompute
data_source FormulaAndFunctionEventsDataSource
name str Name of the query for use in formulas.
group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional]
indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional]
search FormulaAndFunctionEventQueryDefinitionSearch [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventQueryDefinitionCompute/index.html b/v1/FormulaAndFunctionEventQueryDefinitionCompute/index.html index 6fc3e76d5e..0a22062bf0 100644 --- a/v1/FormulaAndFunctionEventQueryDefinitionCompute/index.html +++ b/v1/FormulaAndFunctionEventQueryDefinitionCompute/index.html @@ -1 +1 @@ - FormulaAndFunctionEventQueryDefinitionCompute - Datadog API Client for Python
\ No newline at end of file + FormulaAndFunctionEventQueryDefinitionCompute - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventQueryDefinitionSearch/index.html b/v1/FormulaAndFunctionEventQueryDefinitionSearch/index.html index 252d792e8f..be9c4ae122 100644 --- a/v1/FormulaAndFunctionEventQueryDefinitionSearch/index.html +++ b/v1/FormulaAndFunctionEventQueryDefinitionSearch/index.html @@ -1 +1 @@ - FormulaAndFunctionEventQueryDefinitionSearch - Datadog API Client for Python
\ No newline at end of file + FormulaAndFunctionEventQueryDefinitionSearch - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventQueryGroupBy/index.html b/v1/FormulaAndFunctionEventQueryGroupBy/index.html index eab4548197..43e3535311 100644 --- a/v1/FormulaAndFunctionEventQueryGroupBy/index.html +++ b/v1/FormulaAndFunctionEventQueryGroupBy/index.html @@ -1 +1 @@ - FormulaAndFunctionEventQueryGroupBy - Datadog API Client for Python
\ No newline at end of file + FormulaAndFunctionEventQueryGroupBy - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventQueryGroupBySort/index.html b/v1/FormulaAndFunctionEventQueryGroupBySort/index.html index a8633db7d4..5b618f38f8 100644 --- a/v1/FormulaAndFunctionEventQueryGroupBySort/index.html +++ b/v1/FormulaAndFunctionEventQueryGroupBySort/index.html @@ -1 +1 @@ - FormulaAndFunctionEventQueryGroupBySort - Datadog API Client for Python
\ No newline at end of file + FormulaAndFunctionEventQueryGroupBySort - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/FormulaAndFunctionEventsDataSource/index.html b/v1/FormulaAndFunctionEventsDataSource/index.html index db4c7b7a68..4dbed86367 100644 --- a/v1/FormulaAndFunctionEventsDataSource/index.html +++ b/v1/FormulaAndFunctionEventsDataSource/index.html @@ -1 +1 @@ - FormulaAndFunctionEventsDataSource - Datadog API Client for Python

FormulaAndFunctionEventsDataSource

Data source for event platform-based queries.

Properties

Name Type Description Notes
value str Data source for event platform-based queries. must be one of ["logs", "spans", "network", "rum", "security_signals", "profiles", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 10, 2021
\ No newline at end of file + FormulaAndFunctionEventsDataSource - Datadog API Client for Python

FormulaAndFunctionEventsDataSource

Data source for event platform-based queries.

Properties

Name Type Description Notes
value str Data source for event platform-based queries. must be one of ["logs", "spans", "network", "rum", "security_signals", "profiles", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionMetricAggregation/index.html b/v1/FormulaAndFunctionMetricAggregation/index.html index 76708974f2..8f9e1b6ad6 100644 --- a/v1/FormulaAndFunctionMetricAggregation/index.html +++ b/v1/FormulaAndFunctionMetricAggregation/index.html @@ -1 +1 @@ - FormulaAndFunctionMetricAggregation - Datadog API Client for Python

FormulaAndFunctionMetricAggregation

The aggregation methods available for metrics queries.

Properties

Name Type Description Notes
value str The aggregation methods available for metrics queries. must be one of ["avg", "min", "max", "sum", "last", "area", "l2norm", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 26, 2021
\ No newline at end of file + FormulaAndFunctionMetricAggregation - Datadog API Client for Python

FormulaAndFunctionMetricAggregation

The aggregation methods available for metrics queries.

Properties

Name Type Description Notes
value str The aggregation methods available for metrics queries. must be one of ["avg", "min", "max", "sum", "last", "area", "l2norm", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionMetricDataSource/index.html b/v1/FormulaAndFunctionMetricDataSource/index.html index 5f7b660bf9..c6b0911abe 100644 --- a/v1/FormulaAndFunctionMetricDataSource/index.html +++ b/v1/FormulaAndFunctionMetricDataSource/index.html @@ -1 +1 @@ - FormulaAndFunctionMetricDataSource - Datadog API Client for Python

FormulaAndFunctionMetricDataSource

Data source for metrics queries.

Properties

Name Type Description Notes
value str Data source for metrics queries. defaults to "metrics", must be one of ["metrics", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 26, 2021
\ No newline at end of file + FormulaAndFunctionMetricDataSource - Datadog API Client for Python

FormulaAndFunctionMetricDataSource

Data source for metrics queries.

Properties

Name Type Description Notes
value str Data source for metrics queries. defaults to "metrics", must be one of ["metrics", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionMetricQueryDefinition/index.html b/v1/FormulaAndFunctionMetricQueryDefinition/index.html index c7eeb75610..6eb8eac593 100644 --- a/v1/FormulaAndFunctionMetricQueryDefinition/index.html +++ b/v1/FormulaAndFunctionMetricQueryDefinition/index.html @@ -1 +1 @@ - FormulaAndFunctionMetricQueryDefinition - Datadog API Client for Python
\ No newline at end of file + FormulaAndFunctionMetricQueryDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/FormulaAndFunctionProcessQueryDataSource/index.html b/v1/FormulaAndFunctionProcessQueryDataSource/index.html index a7a97ba069..f32afd2eb4 100644 --- a/v1/FormulaAndFunctionProcessQueryDataSource/index.html +++ b/v1/FormulaAndFunctionProcessQueryDataSource/index.html @@ -1 +1 @@ - FormulaAndFunctionProcessQueryDataSource - Datadog API Client for Python

FormulaAndFunctionProcessQueryDataSource

Data sources that rely on the process backend.

Properties

Name Type Description Notes
value str Data sources that rely on the process backend. must be one of ["process", "container", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 26, 2021
\ No newline at end of file + FormulaAndFunctionProcessQueryDataSource - Datadog API Client for Python

FormulaAndFunctionProcessQueryDataSource

Data sources that rely on the process backend.

Properties

Name Type Description Notes
value str Data sources that rely on the process backend. must be one of ["process", "container", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionProcessQueryDefinition/index.html b/v1/FormulaAndFunctionProcessQueryDefinition/index.html index 9d5bac43cf..88174baf57 100644 --- a/v1/FormulaAndFunctionProcessQueryDefinition/index.html +++ b/v1/FormulaAndFunctionProcessQueryDefinition/index.html @@ -1 +1 @@ - FormulaAndFunctionProcessQueryDefinition - Datadog API Client for Python

FormulaAndFunctionProcessQueryDefinition

Process query using formulas and functions.

Properties

Name Type Description Notes
data_source FormulaAndFunctionProcessQueryDataSource
metric str Process metric name.
name str Name of query for use in formulas.
aggregator FormulaAndFunctionMetricAggregation [optional]
is_normalized_cpu bool Whether to normalize the CPU percentages. [optional]
limit int Number of hits to return. [optional]
sort QuerySortOrder [optional]
tag_filters [str] An array of tags to filter by. [optional]
text_filter str Text to use as filter. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + FormulaAndFunctionProcessQueryDefinition - Datadog API Client for Python

FormulaAndFunctionProcessQueryDefinition

Process query using formulas and functions.

Properties

Name Type Description Notes
data_source FormulaAndFunctionProcessQueryDataSource
metric str Process metric name.
name str Name of query for use in formulas.
aggregator FormulaAndFunctionMetricAggregation [optional]
is_normalized_cpu bool Whether to normalize the CPU percentages. [optional]
limit int Number of hits to return. [optional]
sort QuerySortOrder [optional]
tag_filters [str] An array of tags to filter by. [optional]
text_filter str Text to use as filter. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionQueryDefinition/index.html b/v1/FormulaAndFunctionQueryDefinition/index.html index 11aada6be4..a6abdf2a5a 100644 --- a/v1/FormulaAndFunctionQueryDefinition/index.html +++ b/v1/FormulaAndFunctionQueryDefinition/index.html @@ -1 +1 @@ - FormulaAndFunctionQueryDefinition - Datadog API Client for Python

FormulaAndFunctionQueryDefinition

A formula and function query.

Properties

Name Type Description Notes
aggregator FormulaAndFunctionMetricAggregation [optional]
group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional]
indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional]
search FormulaAndFunctionEventQueryDefinitionSearch [optional]
is_normalized_cpu bool Whether to normalize the CPU percentages. [optional]
limit int Number of hits to return. [optional]
sort QuerySortOrder [optional]
tag_filters [str] An array of tags to filter by. [optional]
text_filter str Text to use as filter. [optional]
data_source FormulaAndFunctionProcessQueryDataSource [optional]
name str Name of query for use in formulas. [optional]
query str Metrics query definition. [optional]
compute FormulaAndFunctionEventQueryDefinitionCompute [optional]
metric str Process metric name. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + FormulaAndFunctionQueryDefinition - Datadog API Client for Python

FormulaAndFunctionQueryDefinition

A formula and function query.

Properties

Name Type Description Notes
aggregator FormulaAndFunctionMetricAggregation [optional]
group_by [FormulaAndFunctionEventQueryGroupBy] Group by options. [optional]
indexes [str] An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. [optional]
search FormulaAndFunctionEventQueryDefinitionSearch [optional]
is_normalized_cpu bool Whether to normalize the CPU percentages. [optional]
limit int Number of hits to return. [optional]
sort QuerySortOrder [optional]
tag_filters [str] An array of tags to filter by. [optional]
text_filter str Text to use as filter. [optional]
data_source FormulaAndFunctionProcessQueryDataSource [optional]
name str Name of query for use in formulas. [optional]
query str Metrics query definition. [optional]
compute FormulaAndFunctionEventQueryDefinitionCompute [optional]
metric str Process metric name. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FormulaAndFunctionResponseFormat/index.html b/v1/FormulaAndFunctionResponseFormat/index.html index 37928f7ee4..6a82baa377 100644 --- a/v1/FormulaAndFunctionResponseFormat/index.html +++ b/v1/FormulaAndFunctionResponseFormat/index.html @@ -1 +1 @@ - FormulaAndFunctionResponseFormat - Datadog API Client for Python

FormulaAndFunctionResponseFormat

Timeseries or Scalar response. This feature is currently in beta.

Properties

Name Type Description Notes
value str Timeseries or Scalar response. This feature is currently in beta. must be one of ["timeseries", "scalar", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file + FormulaAndFunctionResponseFormat - Datadog API Client for Python

FormulaAndFunctionResponseFormat

Timeseries or Scalar response. This feature is currently in beta.

Properties

Name Type Description Notes
value str Timeseries or Scalar response. This feature is currently in beta. must be one of ["timeseries", "scalar", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FreeTextWidgetDefinition/index.html b/v1/FreeTextWidgetDefinition/index.html index c7025c9421..e8655c9edd 100644 --- a/v1/FreeTextWidgetDefinition/index.html +++ b/v1/FreeTextWidgetDefinition/index.html @@ -1 +1 @@ - FreeTextWidgetDefinition - Datadog API Client for Python

FreeTextWidgetDefinition

Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
text str Text to display.
type FreeTextWidgetDefinitionType
color str Color of the text. [optional]
font_size str Size of the text. [optional]
text_align WidgetTextAlign [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + FreeTextWidgetDefinition - Datadog API Client for Python

FreeTextWidgetDefinition

Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
text str Text to display.
type FreeTextWidgetDefinitionType
color str Color of the text. [optional]
font_size str Size of the text. [optional]
text_align WidgetTextAlign [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/FreeTextWidgetDefinitionType/index.html b/v1/FreeTextWidgetDefinitionType/index.html index 3f053c1172..ae0e115249 100644 --- a/v1/FreeTextWidgetDefinitionType/index.html +++ b/v1/FreeTextWidgetDefinitionType/index.html @@ -1 +1 @@ - FreeTextWidgetDefinitionType - Datadog API Client for Python

FreeTextWidgetDefinitionType

Type of the free text widget.

Properties

Name Type Description Notes
value str Type of the free text widget. defaults to "free_text", must be one of ["free_text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + FreeTextWidgetDefinitionType - Datadog API Client for Python

FreeTextWidgetDefinitionType

Type of the free text widget.

Properties

Name Type Description Notes
value str Type of the free text widget. defaults to "free_text", must be one of ["free_text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GCPAccount/index.html b/v1/GCPAccount/index.html index e9450a4c4d..813df5c96f 100644 --- a/v1/GCPAccount/index.html +++ b/v1/GCPAccount/index.html @@ -1 +1 @@ - GCPAccount - Datadog API Client for Python

GCPAccount

Your Google Cloud Platform Account.

Properties

Name Type Description Notes
auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional]
auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional]
automute bool Silence monitors for expected GCE instance shutdowns. [optional]
client_email str Your email found in your JSON service account key. [optional]
client_id str Your ID found in your JSON service account key. [optional]
client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>` where `<CLIENT_EMAIL>` is the email found in your JSON service account key. [optional]
errors [str] An array of errors. [optional]
host_filters str Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. [optional]
private_key str Your private key name found in your JSON service account key. [optional]
private_key_id str Your private key ID found in your JSON service account key. [optional]
project_id str Your Google Cloud project ID found in your JSON service account key. [optional]
token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional]
type str The value for service_account found in your JSON service account key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + GCPAccount - Datadog API Client for Python

GCPAccount

Your Google Cloud Platform Account.

Properties

Name Type Description Notes
auth_provider_x509_cert_url str Should be `https://www.googleapis.com/oauth2/v1/certs`. [optional]
auth_uri str Should be `https://accounts.google.com/o/oauth2/auth`. [optional]
automute bool Silence monitors for expected GCE instance shutdowns. [optional]
client_email str Your email found in your JSON service account key. [optional]
client_id str Your ID found in your JSON service account key. [optional]
client_x509_cert_url str Should be `https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>` where `<CLIENT_EMAIL>` is the email found in your JSON service account key. [optional]
errors [str] An array of errors. [optional]
host_filters str Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. [optional]
private_key str Your private key name found in your JSON service account key. [optional]
private_key_id str Your private key ID found in your JSON service account key. [optional]
project_id str Your Google Cloud project ID found in your JSON service account key. [optional]
token_uri str Should be `https://accounts.google.com/o/oauth2/token`. [optional]
type str The value for service_account found in your JSON service account key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GCPAccountListResponse/index.html b/v1/GCPAccountListResponse/index.html index 8b277de3cf..1a830c1e59 100644 --- a/v1/GCPAccountListResponse/index.html +++ b/v1/GCPAccountListResponse/index.html @@ -1 +1 @@ - GCPAccountListResponse - Datadog API Client for Python
\ No newline at end of file + GCPAccountListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/GCPIntegrationApi/index.html b/v1/GCPIntegrationApi/index.html index 9310b2abc9..10fb0a1778 100644 --- a/v1/GCPIntegrationApi/index.html +++ b/v1/GCPIntegrationApi/index.html @@ -167,4 +167,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling GCPIntegrationApi->update_gcp_integration: %s\n" % e) -

Parameters

Name Type Description Notes
body GCPAccount Update a Datadog-GCP integration.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body GCPAccount Update a Datadog-GCP integration.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GeomapWidgetDefinition/index.html b/v1/GeomapWidgetDefinition/index.html index 099cd17819..b727b44b1f 100644 --- a/v1/GeomapWidgetDefinition/index.html +++ b/v1/GeomapWidgetDefinition/index.html @@ -1 +1 @@ - GeomapWidgetDefinition - Datadog API Client for Python

GeomapWidgetDefinition

This visualization displays a series of values by country on a world map.

Properties

Name Type Description Notes
requests [GeomapWidgetRequest] Array of one request object to display in the widget. The request must contain a `group-by` tag whose value is a country ISO code. See the Request JSON schema documentation for information about building the `REQUEST_SCHEMA`.
style GeomapWidgetDefinitionStyle
type GeomapWidgetDefinitionType
view GeomapWidgetDefinitionView
custom_links [WidgetCustomLink] A list of custom links. [optional]
time WidgetTime [optional]
title str The title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str The size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + GeomapWidgetDefinition - Datadog API Client for Python

GeomapWidgetDefinition

This visualization displays a series of values by country on a world map.

Properties

Name Type Description Notes
requests [GeomapWidgetRequest] Array of one request object to display in the widget. The request must contain a `group-by` tag whose value is a country ISO code. See the Request JSON schema documentation for information about building the `REQUEST_SCHEMA`.
style GeomapWidgetDefinitionStyle
type GeomapWidgetDefinitionType
view GeomapWidgetDefinitionView
custom_links [WidgetCustomLink] A list of custom links. [optional]
time WidgetTime [optional]
title str The title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str The size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GeomapWidgetDefinitionStyle/index.html b/v1/GeomapWidgetDefinitionStyle/index.html index 3fe67c0ade..486600102d 100644 --- a/v1/GeomapWidgetDefinitionStyle/index.html +++ b/v1/GeomapWidgetDefinitionStyle/index.html @@ -1 +1 @@ - GeomapWidgetDefinitionStyle - Datadog API Client for Python

GeomapWidgetDefinitionStyle

The style to apply to the widget.

Properties

Name Type Description Notes
palette str The color palette to apply to the widget.
palette_flip bool Whether to flip the palette tones.

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + GeomapWidgetDefinitionStyle - Datadog API Client for Python

GeomapWidgetDefinitionStyle

The style to apply to the widget.

Properties

Name Type Description Notes
palette str The color palette to apply to the widget.
palette_flip bool Whether to flip the palette tones.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GeomapWidgetDefinitionType/index.html b/v1/GeomapWidgetDefinitionType/index.html index 70b7473870..7ebc76f404 100644 --- a/v1/GeomapWidgetDefinitionType/index.html +++ b/v1/GeomapWidgetDefinitionType/index.html @@ -1 +1 @@ - GeomapWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + GeomapWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/GeomapWidgetDefinitionView/index.html b/v1/GeomapWidgetDefinitionView/index.html index 9847bf108f..b4bd048d91 100644 --- a/v1/GeomapWidgetDefinitionView/index.html +++ b/v1/GeomapWidgetDefinitionView/index.html @@ -1 +1 @@ - GeomapWidgetDefinitionView - Datadog API Client for Python

GeomapWidgetDefinitionView

The view of the world that the map should render.

Properties

Name Type Description Notes
focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`.

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + GeomapWidgetDefinitionView - Datadog API Client for Python

GeomapWidgetDefinitionView

The view of the world that the map should render.

Properties

Name Type Description Notes
focus str The 2-letter ISO code of a country to focus the map on. Or `WORLD`.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GeomapWidgetRequest/index.html b/v1/GeomapWidgetRequest/index.html index 76094d1b61..720e23274b 100644 --- a/v1/GeomapWidgetRequest/index.html +++ b/v1/GeomapWidgetRequest/index.html @@ -1 +1 @@ - GeomapWidgetRequest - Datadog API Client for Python
\ No newline at end of file + GeomapWidgetRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/GraphSnapshot/index.html b/v1/GraphSnapshot/index.html index 729e4ece34..216ab2fc33 100644 --- a/v1/GraphSnapshot/index.html +++ b/v1/GraphSnapshot/index.html @@ -1 +1 @@ - GraphSnapshot - Datadog API Client for Python

GraphSnapshot

Object representing a graph snapshot.

Properties

Name Type Description Notes
graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional]
metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional]
snapshot_url str URL of your graph snapshot. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + GraphSnapshot - Datadog API Client for Python

GraphSnapshot

Object representing a graph snapshot.

Properties

Name Type Description Notes
graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional]
metric_query str The metric query. One of `metric_query` or `graph_def` is required. [optional]
snapshot_url str URL of your graph snapshot. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/GroupWidgetDefinition/index.html b/v1/GroupWidgetDefinition/index.html index 218e0d65dd..77dcacceab 100644 --- a/v1/GroupWidgetDefinition/index.html +++ b/v1/GroupWidgetDefinition/index.html @@ -1 +1 @@ - GroupWidgetDefinition - Datadog API Client for Python
\ No newline at end of file + GroupWidgetDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/GroupWidgetDefinitionType/index.html b/v1/GroupWidgetDefinitionType/index.html index cb67d7f6ad..b1f6196f88 100644 --- a/v1/GroupWidgetDefinitionType/index.html +++ b/v1/GroupWidgetDefinitionType/index.html @@ -1 +1 @@ - GroupWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + GroupWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HTTPMethod/index.html b/v1/HTTPMethod/index.html index 9209157808..a41cf4c628 100644 --- a/v1/HTTPMethod/index.html +++ b/v1/HTTPMethod/index.html @@ -1 +1 @@ - HTTPMethod - Datadog API Client for Python
\ No newline at end of file + HTTPMethod - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HeatMapWidgetDefinition/index.html b/v1/HeatMapWidgetDefinition/index.html index 6bcf18e700..0b50891ae3 100644 --- a/v1/HeatMapWidgetDefinition/index.html +++ b/v1/HeatMapWidgetDefinition/index.html @@ -1 +1 @@ - HeatMapWidgetDefinition - Datadog API Client for Python

HeatMapWidgetDefinition

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

Properties

Name Type Description Notes
requests [HeatMapWidgetRequest] List of widget types.
type HeatMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
events [WidgetEvent] List of widget events. [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool Whether or not to display the legend on this widget. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HeatMapWidgetDefinition - Datadog API Client for Python

HeatMapWidgetDefinition

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

Properties

Name Type Description Notes
requests [HeatMapWidgetRequest] List of widget types.
type HeatMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
events [WidgetEvent] List of widget events. [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool Whether or not to display the legend on this widget. [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HeatMapWidgetDefinitionType/index.html b/v1/HeatMapWidgetDefinitionType/index.html index f262e43de0..7184fb6297 100644 --- a/v1/HeatMapWidgetDefinitionType/index.html +++ b/v1/HeatMapWidgetDefinitionType/index.html @@ -1 +1 @@ - HeatMapWidgetDefinitionType - Datadog API Client for Python

HeatMapWidgetDefinitionType

Type of the heat map widget.

Properties

Name Type Description Notes
value str Type of the heat map widget. defaults to "heatmap", must be one of ["heatmap", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + HeatMapWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HeatMapWidgetRequest/index.html b/v1/HeatMapWidgetRequest/index.html index 08e0435832..07bb277c8a 100644 --- a/v1/HeatMapWidgetRequest/index.html +++ b/v1/HeatMapWidgetRequest/index.html @@ -1 +1 @@ - HeatMapWidgetRequest - Datadog API Client for Python

HeatMapWidgetRequest

Updated heat map widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query EventQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + HeatMapWidgetRequest - Datadog API Client for Python

HeatMapWidgetRequest

Updated heat map widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query EventQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Host/index.html b/v1/Host/index.html index d18739d23f..04553c5036 100644 --- a/v1/Host/index.html +++ b/v1/Host/index.html @@ -1 +1 @@ - Host - Datadog API Client for Python

Host

Object representing a host.

Properties

Name Type Description Notes
aliases [str] Host aliases collected by Datadog. [optional]
apps [str] The Datadog integrations reporting metrics for the host. [optional]
aws_name str AWS name of your host. [optional]
host_name str The host name. [optional]
id int The host ID. [optional]
is_muted bool If a host is muted or unmuted. [optional]
last_reported_time int Last time the host reported a metric data point. [optional]
meta HostMeta [optional]
metrics HostMetrics [optional]
mute_timeout int Timeout of the mute applied to your host. [optional]
name str The host name. [optional]
sources [str] Source or cloud provider associated with your host. [optional]
tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional]
up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + Host - Datadog API Client for Python

Host

Object representing a host.

Properties

Name Type Description Notes
aliases [str] Host aliases collected by Datadog. [optional]
apps [str] The Datadog integrations reporting metrics for the host. [optional]
aws_name str AWS name of your host. [optional]
host_name str The host name. [optional]
id int The host ID. [optional]
is_muted bool If a host is muted or unmuted. [optional]
last_reported_time int Last time the host reported a metric data point. [optional]
meta HostMeta [optional]
metrics HostMetrics [optional]
mute_timeout int Timeout of the mute applied to your host. [optional]
name str The host name. [optional]
sources [str] Source or cloud provider associated with your host. [optional]
tags_by_source {str: ([str],)} List of tags for each source (AWS, Datadog Agent, Chef..). [optional]
up bool Displays UP when the expected metrics are received and displays `???` if no metrics are received. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostListResponse/index.html b/v1/HostListResponse/index.html index 29ed29c78c..b34c750c08 100644 --- a/v1/HostListResponse/index.html +++ b/v1/HostListResponse/index.html @@ -1 +1 @@ - HostListResponse - Datadog API Client for Python

HostListResponse

Response with Host information from Datadog.

Properties

Name Type Description Notes
host_list [Host] Array of hosts. [optional]
total_matching int Number of host matching the query. [optional]
total_returned int Number of host returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostListResponse - Datadog API Client for Python

HostListResponse

Response with Host information from Datadog.

Properties

Name Type Description Notes
host_list [Host] Array of hosts. [optional]
total_matching int Number of host matching the query. [optional]
total_returned int Number of host returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMapRequest/index.html b/v1/HostMapRequest/index.html index 4274574ba5..a7c68bf992 100644 --- a/v1/HostMapRequest/index.html +++ b/v1/HostMapRequest/index.html @@ -1 +1 @@ - HostMapRequest - Datadog API Client for Python

HostMapRequest

Updated host map.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + HostMapRequest - Datadog API Client for Python

HostMapRequest

Updated host map.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMapWidgetDefinition/index.html b/v1/HostMapWidgetDefinition/index.html index 485df33d54..2448640e3f 100644 --- a/v1/HostMapWidgetDefinition/index.html +++ b/v1/HostMapWidgetDefinition/index.html @@ -1 +1 @@ - HostMapWidgetDefinition - Datadog API Client for Python

HostMapWidgetDefinition

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

Properties

Name Type Description Notes
requests HostMapWidgetDefinitionRequests
type HostMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
group [str] List of tag prefixes to group by. [optional]
no_group_hosts bool Whether to show the hosts that don’t fit in a group. [optional]
no_metric_hosts bool Whether to show the hosts with no metrics. [optional]
node_type WidgetNodeType [optional]
notes str Notes on the title. [optional]
scope [str] List of tags used to filter the map. [optional]
style HostMapWidgetDefinitionStyle [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostMapWidgetDefinition - Datadog API Client for Python

HostMapWidgetDefinition

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

Properties

Name Type Description Notes
requests HostMapWidgetDefinitionRequests
type HostMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
group [str] List of tag prefixes to group by. [optional]
no_group_hosts bool Whether to show the hosts that don’t fit in a group. [optional]
no_metric_hosts bool Whether to show the hosts with no metrics. [optional]
node_type WidgetNodeType [optional]
notes str Notes on the title. [optional]
scope [str] List of tags used to filter the map. [optional]
style HostMapWidgetDefinitionStyle [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMapWidgetDefinitionRequests/index.html b/v1/HostMapWidgetDefinitionRequests/index.html index d59899493c..5b12133bbd 100644 --- a/v1/HostMapWidgetDefinitionRequests/index.html +++ b/v1/HostMapWidgetDefinitionRequests/index.html @@ -1 +1 @@ - HostMapWidgetDefinitionRequests - Datadog API Client for Python
\ No newline at end of file + HostMapWidgetDefinitionRequests - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HostMapWidgetDefinitionStyle/index.html b/v1/HostMapWidgetDefinitionStyle/index.html index 58b6974868..bf0b2b9880 100644 --- a/v1/HostMapWidgetDefinitionStyle/index.html +++ b/v1/HostMapWidgetDefinitionStyle/index.html @@ -1 +1 @@ - HostMapWidgetDefinitionStyle - Datadog API Client for Python

HostMapWidgetDefinitionStyle

The style to apply to the widget.

Properties

Name Type Description Notes
fill_max str Max value to use to color the map. [optional]
fill_min str Min value to use to color the map. [optional]
palette str Color palette to apply to the widget. [optional]
palette_flip bool Whether to flip the palette tones. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostMapWidgetDefinitionStyle - Datadog API Client for Python

HostMapWidgetDefinitionStyle

The style to apply to the widget.

Properties

Name Type Description Notes
fill_max str Max value to use to color the map. [optional]
fill_min str Min value to use to color the map. [optional]
palette str Color palette to apply to the widget. [optional]
palette_flip bool Whether to flip the palette tones. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMapWidgetDefinitionType/index.html b/v1/HostMapWidgetDefinitionType/index.html index dd7a8bb9e8..973c57a19e 100644 --- a/v1/HostMapWidgetDefinitionType/index.html +++ b/v1/HostMapWidgetDefinitionType/index.html @@ -1 +1 @@ - HostMapWidgetDefinitionType - Datadog API Client for Python

HostMapWidgetDefinitionType

Type of the host map widget.

Properties

Name Type Description Notes
value str Type of the host map widget. defaults to "hostmap", must be one of ["hostmap", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + HostMapWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HostMeta/index.html b/v1/HostMeta/index.html index b8ada7432f..e4b010e507 100644 --- a/v1/HostMeta/index.html +++ b/v1/HostMeta/index.html @@ -1 +1 @@ - HostMeta - Datadog API Client for Python
\ No newline at end of file + HostMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HostMetrics/index.html b/v1/HostMetrics/index.html index d055e8a407..d732313b20 100644 --- a/v1/HostMetrics/index.html +++ b/v1/HostMetrics/index.html @@ -1 +1 @@ - HostMetrics - Datadog API Client for Python

HostMetrics

Host Metrics collected.

Properties

Name Type Description Notes
cpu float The percent of CPU used (everything but idle). [optional]
iowait float The percent of CPU spent waiting on the IO (not reported for all platforms). [optional]
load float The system load over the last 15 minutes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostMetrics - Datadog API Client for Python

HostMetrics

Host Metrics collected.

Properties

Name Type Description Notes
cpu float The percent of CPU used (everything but idle). [optional]
iowait float The percent of CPU spent waiting on the IO (not reported for all platforms). [optional]
load float The system load over the last 15 minutes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMuteResponse/index.html b/v1/HostMuteResponse/index.html index c7dc000fde..ce0b07568a 100644 --- a/v1/HostMuteResponse/index.html +++ b/v1/HostMuteResponse/index.html @@ -1 +1 @@ - HostMuteResponse - Datadog API Client for Python

HostMuteResponse

Response with the list of muted host for your organization.

Properties

Name Type Description Notes
action str Action applied to the hosts. [optional]
end int POSIX timestamp in seconds when the host is unmuted. [optional]
hostname str The host name. [optional]
message str Message associated with the mute. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostMuteResponse - Datadog API Client for Python

HostMuteResponse

Response with the list of muted host for your organization.

Properties

Name Type Description Notes
action str Action applied to the hosts. [optional]
end int POSIX timestamp in seconds when the host is unmuted. [optional]
hostname str The host name. [optional]
message str Message associated with the mute. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostMuteSettings/index.html b/v1/HostMuteSettings/index.html index 1546346e40..4f3977350d 100644 --- a/v1/HostMuteSettings/index.html +++ b/v1/HostMuteSettings/index.html @@ -1 +1 @@ - HostMuteSettings - Datadog API Client for Python

HostMuteSettings

Combination of settings to mute a host.

Properties

Name Type Description Notes
end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional]
message str Message to associate with the muting of this host. [optional]
override bool If true and the host is already muted, replaces existing host mute settings. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostMuteSettings - Datadog API Client for Python

HostMuteSettings

Combination of settings to mute a host.

Properties

Name Type Description Notes
end int POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. [optional]
message str Message to associate with the muting of this host. [optional]
override bool If true and the host is already muted, replaces existing host mute settings. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostTags/index.html b/v1/HostTags/index.html index 8121203a25..5c26d79cbb 100644 --- a/v1/HostTags/index.html +++ b/v1/HostTags/index.html @@ -1 +1 @@ - HostTags - Datadog API Client for Python
\ No newline at end of file + HostTags - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/HostTotals/index.html b/v1/HostTotals/index.html index 6ef1a34d0d..4bf61f90f7 100644 --- a/v1/HostTotals/index.html +++ b/v1/HostTotals/index.html @@ -1 +1 @@ - HostTotals - Datadog API Client for Python

HostTotals

Total number of host currently monitored by Datadog.

Properties

Name Type Description Notes
total_active int Total number of active host (UP and ???) reporting to Datadog. [optional]
total_up int Number of host that are UP and reporting to Datadog. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + HostTotals - Datadog API Client for Python

HostTotals

Total number of host currently monitored by Datadog.

Properties

Name Type Description Notes
total_active int Total number of active host (UP and ???) reporting to Datadog. [optional]
total_up int Number of host that are UP and reporting to Datadog. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/HostsApi/index.html b/v1/HostsApi/index.html index ffaaeff4c8..885faeb707 100644 --- a/v1/HostsApi/index.html +++ b/v1/HostsApi/index.html @@ -140,4 +140,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling HostsApi->unmute_host: %s\n" % e) -

Parameters

Name Type Description Notes
host_name str Name of the host to unmute.

Return type

HostMuteResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Invalid Parameter Error -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
host_name str Name of the host to unmute.

Return type

HostMuteResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Invalid Parameter Error -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IFrameWidgetDefinition/index.html b/v1/IFrameWidgetDefinition/index.html index 40d52702d7..b156e37ebb 100644 --- a/v1/IFrameWidgetDefinition/index.html +++ b/v1/IFrameWidgetDefinition/index.html @@ -1 +1 @@ - IFrameWidgetDefinition - Datadog API Client for Python
\ No newline at end of file + IFrameWidgetDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/IFrameWidgetDefinitionType/index.html b/v1/IFrameWidgetDefinitionType/index.html index 14b0282a83..6bbe326d02 100644 --- a/v1/IFrameWidgetDefinitionType/index.html +++ b/v1/IFrameWidgetDefinitionType/index.html @@ -1 +1 @@ - IFrameWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + IFrameWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/IPPrefixesAPI/index.html b/v1/IPPrefixesAPI/index.html index aab840a873..2351c62df9 100644 --- a/v1/IPPrefixesAPI/index.html +++ b/v1/IPPrefixesAPI/index.html @@ -1 +1 @@ - IPPrefixesAPI - Datadog API Client for Python

IPPrefixesAPI

Available prefix information for the API endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesAPI - Datadog API Client for Python

IPPrefixesAPI

Available prefix information for the API endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesAPM/index.html b/v1/IPPrefixesAPM/index.html index f08808b82c..dae39051aa 100644 --- a/v1/IPPrefixesAPM/index.html +++ b/v1/IPPrefixesAPM/index.html @@ -1 +1 @@ - IPPrefixesAPM - Datadog API Client for Python

IPPrefixesAPM

Available prefix information for the APM endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesAPM - Datadog API Client for Python

IPPrefixesAPM

Available prefix information for the APM endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesAgents/index.html b/v1/IPPrefixesAgents/index.html index 2b45a4716d..77f5f40f43 100644 --- a/v1/IPPrefixesAgents/index.html +++ b/v1/IPPrefixesAgents/index.html @@ -1 +1 @@ - IPPrefixesAgents - Datadog API Client for Python

IPPrefixesAgents

Available prefix information for the Agent endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesAgents - Datadog API Client for Python

IPPrefixesAgents

Available prefix information for the Agent endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesLogs/index.html b/v1/IPPrefixesLogs/index.html index 8781ed383d..005ef627a9 100644 --- a/v1/IPPrefixesLogs/index.html +++ b/v1/IPPrefixesLogs/index.html @@ -1 +1 @@ - IPPrefixesLogs - Datadog API Client for Python

IPPrefixesLogs

Available prefix information for the Logs endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesLogs - Datadog API Client for Python

IPPrefixesLogs

Available prefix information for the Logs endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesProcess/index.html b/v1/IPPrefixesProcess/index.html index 5f43251780..ea782c23ee 100644 --- a/v1/IPPrefixesProcess/index.html +++ b/v1/IPPrefixesProcess/index.html @@ -1 +1 @@ - IPPrefixesProcess - Datadog API Client for Python

IPPrefixesProcess

Available prefix information for the Process endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesProcess - Datadog API Client for Python

IPPrefixesProcess

Available prefix information for the Process endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesSynthetics/index.html b/v1/IPPrefixesSynthetics/index.html index edea60ff05..c19b0f570d 100644 --- a/v1/IPPrefixesSynthetics/index.html +++ b/v1/IPPrefixesSynthetics/index.html @@ -1 +1 @@ - IPPrefixesSynthetics - Datadog API Client for Python

IPPrefixesSynthetics

Available prefix information for the Synthetics endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]
prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 12, 2020
\ No newline at end of file + IPPrefixesSynthetics - Datadog API Client for Python

IPPrefixesSynthetics

Available prefix information for the Synthetics endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv4_by_location {str: ([str],)} List of IPv4 prefixes by location. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]
prefixes_ipv6_by_location {str: ([str],)} List of IPv6 prefixes by location. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPPrefixesWebhooks/index.html b/v1/IPPrefixesWebhooks/index.html index 287380877e..e7bbd92af7 100644 --- a/v1/IPPrefixesWebhooks/index.html +++ b/v1/IPPrefixesWebhooks/index.html @@ -1 +1 @@ - IPPrefixesWebhooks - Datadog API Client for Python

IPPrefixesWebhooks

Available prefix information for the Webhook endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPPrefixesWebhooks - Datadog API Client for Python

IPPrefixesWebhooks

Available prefix information for the Webhook endpoints.

Properties

Name Type Description Notes
prefixes_ipv4 [str] List of IPv4 prefixes. [optional]
prefixes_ipv6 [str] List of IPv6 prefixes. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPRanges/index.html b/v1/IPRanges/index.html index 32c2cbbe97..2a293a392d 100644 --- a/v1/IPRanges/index.html +++ b/v1/IPRanges/index.html @@ -1 +1 @@ - IPRanges - Datadog API Client for Python

IPRanges

IP ranges.

Properties

Name Type Description Notes
agents IPPrefixesAgents [optional]
api IPPrefixesAPI [optional]
apm IPPrefixesAPM [optional]
logs IPPrefixesLogs [optional]
modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional]
process IPPrefixesProcess [optional]
synthetics IPPrefixesSynthetics [optional]
version int Version of the IP list. [optional]
webhooks IPPrefixesWebhooks [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + IPRanges - Datadog API Client for Python

IPRanges

IP ranges.

Properties

Name Type Description Notes
agents IPPrefixesAgents [optional]
api IPPrefixesAPI [optional]
apm IPPrefixesAPM [optional]
logs IPPrefixesLogs [optional]
modified str Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. [optional]
process IPPrefixesProcess [optional]
synthetics IPPrefixesSynthetics [optional]
version int Version of the IP list. [optional]
webhooks IPPrefixesWebhooks [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IPRangesApi/index.html b/v1/IPRangesApi/index.html index 60caa918b0..6e5e02cdf8 100644 --- a/v1/IPRangesApi/index.html +++ b/v1/IPRangesApi/index.html @@ -23,4 +23,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling IPRangesApi->get_ip_ranges: %s\n" % e) -

Parameters

This endpoint does not need any parameter.

Return type

IPRanges

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

This endpoint does not need any parameter.

Return type

IPRanges

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/IdpFormData/index.html b/v1/IdpFormData/index.html index 66f545f2da..bee216485e 100644 --- a/v1/IdpFormData/index.html +++ b/v1/IdpFormData/index.html @@ -1 +1 @@ - IdpFormData - Datadog API Client for Python
\ No newline at end of file + IdpFormData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/IdpResponse/index.html b/v1/IdpResponse/index.html index be5b46faf6..9ba9cd5d05 100644 --- a/v1/IdpResponse/index.html +++ b/v1/IdpResponse/index.html @@ -1 +1 @@ - IdpResponse - Datadog API Client for Python
\ No newline at end of file + IdpResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ImageWidgetDefinition/index.html b/v1/ImageWidgetDefinition/index.html index a99d59e80a..5101d488ec 100644 --- a/v1/ImageWidgetDefinition/index.html +++ b/v1/ImageWidgetDefinition/index.html @@ -1 +1 @@ - ImageWidgetDefinition - Datadog API Client for Python
\ No newline at end of file + ImageWidgetDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ImageWidgetDefinitionType/index.html b/v1/ImageWidgetDefinitionType/index.html index d31f5a5b03..6f41ef6598 100644 --- a/v1/ImageWidgetDefinitionType/index.html +++ b/v1/ImageWidgetDefinitionType/index.html @@ -1 +1 @@ - ImageWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + ImageWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/KeyManagementApi/index.html b/v1/KeyManagementApi/index.html index 280ab88d3d..f238935b5d 100644 --- a/v1/KeyManagementApi/index.html +++ b/v1/KeyManagementApi/index.html @@ -336,4 +336,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling KeyManagementApi->update_application_key: %s\n" % e) -

Parameters

Name Type Description Notes
key str The specific APP key you are working with.
body ApplicationKey

Return type

ApplicationKeyResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
409 Conflict -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
key str The specific APP key you are working with.
body ApplicationKey

Return type

ApplicationKeyResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
409 Conflict -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Log/index.html b/v1/Log/index.html index 653b555b73..6a05f81177 100644 --- a/v1/Log/index.html +++ b/v1/Log/index.html @@ -1 +1 @@ - Log - Datadog API Client for Python
\ No newline at end of file + Log - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogContent/index.html b/v1/LogContent/index.html index f769c08e14..ad3fe45e14 100644 --- a/v1/LogContent/index.html +++ b/v1/LogContent/index.html @@ -1 +1 @@ - LogContent - Datadog API Client for Python

LogContent

JSON object containing all log attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional]
host str Name of the machine from where the logs are being sent. [optional]
message str The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. [optional]
service str The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. [optional]
tags [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional]
timestamp datetime Timestamp of your log. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogContent - Datadog API Client for Python

LogContent

JSON object containing all log attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional]
host str Name of the machine from where the logs are being sent. [optional]
message str The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. [optional]
service str The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. [optional]
tags [bool, date, datetime, dict, float, int, list, str, none_type] Array of tags associated with your log. [optional]
timestamp datetime Timestamp of your log. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogQueryDefinition/index.html b/v1/LogQueryDefinition/index.html index 4f3991d550..536377ae2f 100644 --- a/v1/LogQueryDefinition/index.html +++ b/v1/LogQueryDefinition/index.html @@ -1 +1 @@ - LogQueryDefinition - Datadog API Client for Python

LogQueryDefinition

The log query.

Properties

Name Type Description Notes
compute LogsQueryCompute [optional]
group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional]
index str A coma separated-list of index names. Use \"*\" query all indexes at once. Multiple Indexes [optional]
multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional]
search LogQueryDefinitionSearch [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogQueryDefinition - Datadog API Client for Python

LogQueryDefinition

The log query.

Properties

Name Type Description Notes
compute LogsQueryCompute [optional]
group_by [LogQueryDefinitionGroupBy] List of tag prefixes to group by in the case of a cluster check. [optional]
index str A coma separated-list of index names. Use \"*\" query all indexes at once. Multiple Indexes [optional]
multi_compute [LogsQueryCompute] This field is mutually exclusive with `compute`. [optional]
search LogQueryDefinitionSearch [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogQueryDefinitionGroupBy/index.html b/v1/LogQueryDefinitionGroupBy/index.html index bf953af453..21c9ca33dc 100644 --- a/v1/LogQueryDefinitionGroupBy/index.html +++ b/v1/LogQueryDefinitionGroupBy/index.html @@ -1 +1 @@ - LogQueryDefinitionGroupBy - Datadog API Client for Python
\ No newline at end of file + LogQueryDefinitionGroupBy - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogQueryDefinitionGroupBySort/index.html b/v1/LogQueryDefinitionGroupBySort/index.html index e751e33ed1..ad002832f7 100644 --- a/v1/LogQueryDefinitionGroupBySort/index.html +++ b/v1/LogQueryDefinitionGroupBySort/index.html @@ -1 +1 @@ - LogQueryDefinitionGroupBySort - Datadog API Client for Python
\ No newline at end of file + LogQueryDefinitionGroupBySort - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogQueryDefinitionSearch/index.html b/v1/LogQueryDefinitionSearch/index.html index 2d9a3992a2..cb98b6bee9 100644 --- a/v1/LogQueryDefinitionSearch/index.html +++ b/v1/LogQueryDefinitionSearch/index.html @@ -1 +1 @@ - LogQueryDefinitionSearch - Datadog API Client for Python
\ No newline at end of file + LogQueryDefinitionSearch - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogStreamWidgetDefinition/index.html b/v1/LogStreamWidgetDefinition/index.html index 607a7d76c3..3019040d3f 100644 --- a/v1/LogStreamWidgetDefinition/index.html +++ b/v1/LogStreamWidgetDefinition/index.html @@ -1 +1 @@ - LogStreamWidgetDefinition - Datadog API Client for Python

LogStreamWidgetDefinition

The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
type LogStreamWidgetDefinitionType
columns [str] Which columns to display on the widget. [optional]
indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional]
logset str ID of the log set to use. [optional]
message_display WidgetMessageDisplay [optional]
query str Query to filter the log stream with. [optional]
show_date_column bool Whether to show the date column or not [optional]
show_message_column bool Whether to show the message column or not [optional]
sort WidgetFieldSort [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogStreamWidgetDefinition - Datadog API Client for Python

LogStreamWidgetDefinition

The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
type LogStreamWidgetDefinitionType
columns [str] Which columns to display on the widget. [optional]
indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional]
logset str ID of the log set to use. [optional]
message_display WidgetMessageDisplay [optional]
query str Query to filter the log stream with. [optional]
show_date_column bool Whether to show the date column or not [optional]
show_message_column bool Whether to show the message column or not [optional]
sort WidgetFieldSort [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogStreamWidgetDefinitionType/index.html b/v1/LogStreamWidgetDefinitionType/index.html index 0ca9a63349..fdeb958926 100644 --- a/v1/LogStreamWidgetDefinitionType/index.html +++ b/v1/LogStreamWidgetDefinitionType/index.html @@ -1 +1 @@ - LogStreamWidgetDefinitionType - Datadog API Client for Python

LogStreamWidgetDefinitionType

Type of the log stream widget.

Properties

Name Type Description Notes
value str Type of the log stream widget. defaults to "log_stream", must be one of ["log_stream", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogStreamWidgetDefinitionType - Datadog API Client for Python

LogStreamWidgetDefinitionType

Type of the log stream widget.

Properties

Name Type Description Notes
value str Type of the log stream widget. defaults to "log_stream", must be one of ["log_stream", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsAPIError/index.html b/v1/LogsAPIError/index.html index 4a86e5653c..9cb1ec5cb5 100644 --- a/v1/LogsAPIError/index.html +++ b/v1/LogsAPIError/index.html @@ -1 +1 @@ - LogsAPIError - Datadog API Client for Python
\ No newline at end of file + LogsAPIError - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsAPIErrorResponse/index.html b/v1/LogsAPIErrorResponse/index.html index f7f14a6e9e..47b5c7e8ee 100644 --- a/v1/LogsAPIErrorResponse/index.html +++ b/v1/LogsAPIErrorResponse/index.html @@ -1 +1 @@ - LogsAPIErrorResponse - Datadog API Client for Python
\ No newline at end of file + LogsAPIErrorResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsApi/index.html b/v1/LogsApi/index.html index 771d9605bc..9a206155b7 100644 --- a/v1/LogsApi/index.html +++ b/v1/LogsApi/index.html @@ -41,4 +41,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsApi->list_logs: %s\n" % e) -

Parameters

Name Type Description Notes
body LogsListRequest Logs filter

Return type

LogsListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body LogsListRequest Logs filter

Return type

LogsListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsArithmeticProcessor/index.html b/v1/LogsArithmeticProcessor/index.html index b10d362654..4894a6fe75 100644 --- a/v1/LogsArithmeticProcessor/index.html +++ b/v1/LogsArithmeticProcessor/index.html @@ -1 +1 @@ - LogsArithmeticProcessor - Datadog API Client for Python

LogsArithmeticProcessor

Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators -, +, *, /. By default, the calculation is skipped if an attribute is missing. Select “Replace missing attribute by 0” to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes: - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891, the actual value stored for the attribute is 0.123456789. - If you need to scale a unit of measure, see Scale Filter.

Properties

Name Type Description Notes
expression str Arithmetic operation between one or more log attributes.
target str Name of the attribute that contains the result of the arithmetic operation.
type LogsArithmeticProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsArithmeticProcessor - Datadog API Client for Python

LogsArithmeticProcessor

Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators -, +, *, /. By default, the calculation is skipped if an attribute is missing. Select “Replace missing attribute by 0” to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. Notes: - The operator - needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891, the actual value stored for the attribute is 0.123456789. - If you need to scale a unit of measure, see Scale Filter.

Properties

Name Type Description Notes
expression str Arithmetic operation between one or more log attributes.
target str Name of the attribute that contains the result of the arithmetic operation.
type LogsArithmeticProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_replace_missing bool If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsArithmeticProcessorType/index.html b/v1/LogsArithmeticProcessorType/index.html index f48b78c8d2..3dd4b032dc 100644 --- a/v1/LogsArithmeticProcessorType/index.html +++ b/v1/LogsArithmeticProcessorType/index.html @@ -1 +1 @@ - LogsArithmeticProcessorType - Datadog API Client for Python

LogsArithmeticProcessorType

Type of logs arithmetic processor.

Properties

Name Type Description Notes
value str Type of logs arithmetic processor. defaults to "arithmetic-processor", must be one of ["arithmetic-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsArithmeticProcessorType - Datadog API Client for Python

LogsArithmeticProcessorType

Type of logs arithmetic processor.

Properties

Name Type Description Notes
value str Type of logs arithmetic processor. defaults to "arithmetic-processor", must be one of ["arithmetic-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsAttributeRemapper/index.html b/v1/LogsAttributeRemapper/index.html index 452ca481c8..9239fe9712 100644 --- a/v1/LogsAttributeRemapper/index.html +++ b/v1/LogsAttributeRemapper/index.html @@ -1 +1 @@ - LogsAttributeRemapper - Datadog API Client for Python

LogsAttributeRemapper

The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation. Some additional constraints are applied as : or , are not allowed in the target tag/attribute name.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
target str Final attribute or tag name to remap the sources to.
type LogsAttributeRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False
preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False
source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
target_format TargetFormatType [optional]
target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"

[Back to Model list] [Back to API list] [Back to README]

Last update: October 2, 2020
\ No newline at end of file + LogsAttributeRemapper - Datadog API Client for Python

LogsAttributeRemapper

The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation. Some additional constraints are applied as : or , are not allowed in the target tag/attribute name.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
target str Final attribute or tag name to remap the sources to.
type LogsAttributeRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False
preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False
source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
target_format TargetFormatType [optional]
target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsAttributeRemapperType/index.html b/v1/LogsAttributeRemapperType/index.html index 6dd70bbc58..40fff9f459 100644 --- a/v1/LogsAttributeRemapperType/index.html +++ b/v1/LogsAttributeRemapperType/index.html @@ -1 +1 @@ - LogsAttributeRemapperType - Datadog API Client for Python

LogsAttributeRemapperType

Type of logs attribute remapper.

Properties

Name Type Description Notes
value str Type of logs attribute remapper. defaults to "attribute-remapper", must be one of ["attribute-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsAttributeRemapperType - Datadog API Client for Python

LogsAttributeRemapperType

Type of logs attribute remapper.

Properties

Name Type Description Notes
value str Type of logs attribute remapper. defaults to "attribute-remapper", must be one of ["attribute-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsCategoryProcessor/index.html b/v1/LogsCategoryProcessor/index.html index 6380dd34df..4588093f3f 100644 --- a/v1/LogsCategoryProcessor/index.html +++ b/v1/LogsCategoryProcessor/index.html @@ -1 +1 @@ - LogsCategoryProcessor - Datadog API Client for Python

LogsCategoryProcessor

Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.

Properties

Name Type Description Notes
categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log.
target str Name of the target attribute which value is defined by the matching category.
type LogsCategoryProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + LogsCategoryProcessor - Datadog API Client for Python

LogsCategoryProcessor

Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.

Properties

Name Type Description Notes
categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log.
target str Name of the target attribute which value is defined by the matching category.
type LogsCategoryProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsCategoryProcessorCategory/index.html b/v1/LogsCategoryProcessorCategory/index.html index e73f1b67fe..15b89b1875 100644 --- a/v1/LogsCategoryProcessorCategory/index.html +++ b/v1/LogsCategoryProcessorCategory/index.html @@ -1 +1 @@ - LogsCategoryProcessorCategory - Datadog API Client for Python
\ No newline at end of file + LogsCategoryProcessorCategory - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsCategoryProcessorType/index.html b/v1/LogsCategoryProcessorType/index.html index 1ea6dedcd7..a4e5839691 100644 --- a/v1/LogsCategoryProcessorType/index.html +++ b/v1/LogsCategoryProcessorType/index.html @@ -1 +1 @@ - LogsCategoryProcessorType - Datadog API Client for Python

LogsCategoryProcessorType

Type of logs category processor.

Properties

Name Type Description Notes
value str Type of logs category processor. defaults to "category-processor", must be one of ["category-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsCategoryProcessorType - Datadog API Client for Python

LogsCategoryProcessorType

Type of logs category processor.

Properties

Name Type Description Notes
value str Type of logs category processor. defaults to "category-processor", must be one of ["category-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsDateRemapper/index.html b/v1/LogsDateRemapper/index.html index 13d5283fb9..b20228e322 100644 --- a/v1/LogsDateRemapper/index.html +++ b/v1/LogsDateRemapper/index.html @@ -1 +1 @@ - LogsDateRemapper - Datadog API Client for Python

LogsDateRemapper

As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsDateRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsDateRemapper - Datadog API Client for Python

LogsDateRemapper

As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsDateRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsDateRemapperType/index.html b/v1/LogsDateRemapperType/index.html index faa98c1b00..ac1a9cc09a 100644 --- a/v1/LogsDateRemapperType/index.html +++ b/v1/LogsDateRemapperType/index.html @@ -1 +1 @@ - LogsDateRemapperType - Datadog API Client for Python

LogsDateRemapperType

Type of logs date remapper.

Properties

Name Type Description Notes
value str Type of logs date remapper. defaults to "date-remapper", must be one of ["date-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsDateRemapperType - Datadog API Client for Python

LogsDateRemapperType

Type of logs date remapper.

Properties

Name Type Description Notes
value str Type of logs date remapper. defaults to "date-remapper", must be one of ["date-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsExclusion/index.html b/v1/LogsExclusion/index.html index 91c97b374b..7aad356879 100644 --- a/v1/LogsExclusion/index.html +++ b/v1/LogsExclusion/index.html @@ -1 +1 @@ - LogsExclusion - Datadog API Client for Python
\ No newline at end of file + LogsExclusion - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsExclusionFilter/index.html b/v1/LogsExclusionFilter/index.html index 66fab371ff..5a7e0463fc 100644 --- a/v1/LogsExclusionFilter/index.html +++ b/v1/LogsExclusionFilter/index.html @@ -1 +1 @@ - LogsExclusionFilter - Datadog API Client for Python

LogsExclusionFilter

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

Properties

Name Type Description Notes
sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query.
query str Default query is `*`, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsExclusionFilter - Datadog API Client for Python

LogsExclusionFilter

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

Properties

Name Type Description Notes
sample_rate float Sample rate to apply to logs going through this exclusion filter, a value of 1 will exclude all logs matching the query.
query str Default query is `*`, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsFilter/index.html b/v1/LogsFilter/index.html index 096eefa4f2..fa7555cafe 100644 --- a/v1/LogsFilter/index.html +++ b/v1/LogsFilter/index.html @@ -1 +1 @@ - LogsFilter - Datadog API Client for Python
\ No newline at end of file + LogsFilter - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsGeoIPParser/index.html b/v1/LogsGeoIPParser/index.html index 6bcec469f1..3b09ed1400 100644 --- a/v1/LogsGeoIPParser/index.html +++ b/v1/LogsGeoIPParser/index.html @@ -1 +1 @@ - LogsGeoIPParser - Datadog API Client for Python

LogsGeoIPParser

The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path.

Properties

Name Type Description Notes
type LogsGeoIPParserType
sources [str] Array of source attributes. defaults to ["network.client.ip"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "network.client.geoip"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGeoIPParser - Datadog API Client for Python

LogsGeoIPParser

The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path.

Properties

Name Type Description Notes
type LogsGeoIPParserType
sources [str] Array of source attributes. defaults to ["network.client.ip"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "network.client.geoip"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsGeoIPParserType/index.html b/v1/LogsGeoIPParserType/index.html index 0c5527d240..282f9c38a2 100644 --- a/v1/LogsGeoIPParserType/index.html +++ b/v1/LogsGeoIPParserType/index.html @@ -1 +1 @@ - LogsGeoIPParserType - Datadog API Client for Python
\ No newline at end of file + LogsGeoIPParserType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsGrokParser/index.html b/v1/LogsGrokParser/index.html index f44c229cc5..3ca5a0343f 100644 --- a/v1/LogsGrokParser/index.html +++ b/v1/LogsGrokParser/index.html @@ -1 +1 @@ - LogsGrokParser - Datadog API Client for Python

LogsGrokParser

Create custom grok rules to parse the full message or a specific attribute of your raw event. For more information, see the parsing section.

Properties

Name Type Description Notes
grok LogsGrokParserRules
type LogsGrokParserType
source str Name of the log attribute to parse. defaults to "message"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
samples [str] List of sample logs to test this grok parser. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGrokParser - Datadog API Client for Python

LogsGrokParser

Create custom grok rules to parse the full message or a specific attribute of your raw event. For more information, see the parsing section.

Properties

Name Type Description Notes
grok LogsGrokParserRules
type LogsGrokParserType
source str Name of the log attribute to parse. defaults to "message"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
samples [str] List of sample logs to test this grok parser. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsGrokParserRules/index.html b/v1/LogsGrokParserRules/index.html index 64952d0c2b..6f8f8c0e01 100644 --- a/v1/LogsGrokParserRules/index.html +++ b/v1/LogsGrokParserRules/index.html @@ -1 +1 @@ - LogsGrokParserRules - Datadog API Client for Python

LogsGrokParserRules

Set of rules for the grok parser.

Properties

Name Type Description Notes
match_rules str List of match rules for the grok parser, separated by a new line.
support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of ""

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGrokParserRules - Datadog API Client for Python

LogsGrokParserRules

Set of rules for the grok parser.

Properties

Name Type Description Notes
match_rules str List of match rules for the grok parser, separated by a new line.
support_rules str List of support rules for the grok parser, separated by a new line. [optional] if omitted the server will use the default value of ""

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsGrokParserType/index.html b/v1/LogsGrokParserType/index.html index fd9fff44cd..ee479adba5 100644 --- a/v1/LogsGrokParserType/index.html +++ b/v1/LogsGrokParserType/index.html @@ -1 +1 @@ - LogsGrokParserType - Datadog API Client for Python
\ No newline at end of file + LogsGrokParserType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsIndex/index.html b/v1/LogsIndex/index.html index f9ba21a42b..3b3071700b 100644 --- a/v1/LogsIndex/index.html +++ b/v1/LogsIndex/index.html @@ -1 +1 @@ - LogsIndex - Datadog API Client for Python

LogsIndex

Object describing a Datadog Log index.

Properties

Name Type Description Notes
filter LogsFilter
name str The name of the index.
daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional]
exclusion_filters [LogsExclusion] An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. [optional]
is_rate_limited bool A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC. [optional][readonly]
num_retention_days int The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 19, 2021
\ No newline at end of file + LogsIndex - Datadog API Client for Python

LogsIndex

Object describing a Datadog Log index.

Properties

Name Type Description Notes
filter LogsFilter
name str The name of the index.
daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional]
exclusion_filters [LogsExclusion] An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. [optional]
is_rate_limited bool A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC. [optional][readonly]
num_retention_days int The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsIndexListResponse/index.html b/v1/LogsIndexListResponse/index.html index 249c67edfb..df8c8133dc 100644 --- a/v1/LogsIndexListResponse/index.html +++ b/v1/LogsIndexListResponse/index.html @@ -1 +1 @@ - LogsIndexListResponse - Datadog API Client for Python
\ No newline at end of file + LogsIndexListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsIndexUpdateRequest/index.html b/v1/LogsIndexUpdateRequest/index.html index 2dddb787d0..df2ef386bd 100644 --- a/v1/LogsIndexUpdateRequest/index.html +++ b/v1/LogsIndexUpdateRequest/index.html @@ -1 +1 @@ - LogsIndexUpdateRequest - Datadog API Client for Python

LogsIndexUpdateRequest

Object for updating a Datadog Log index.

Properties

Name Type Description Notes
filter LogsFilter
daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional]
disable_daily_limit bool If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored). If false or omitted, the index's current `daily_limit` is maintained. [optional]
exclusion_filters [LogsExclusion] An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. [optional]
num_retention_days int The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. Note: Changing the retention for an index adjusts the length of retention for all logs already in this index. It may also affect billing. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 16, 2020
\ No newline at end of file + LogsIndexUpdateRequest - Datadog API Client for Python

LogsIndexUpdateRequest

Object for updating a Datadog Log index.

Properties

Name Type Description Notes
filter LogsFilter
daily_limit int The number of log events you can send in this index per day before you are rate-limited. [optional]
disable_daily_limit bool If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored). If false or omitted, the index's current `daily_limit` is maintained. [optional]
exclusion_filters [LogsExclusion] An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. [optional]
num_retention_days int The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. Note: Changing the retention for an index adjusts the length of retention for all logs already in this index. It may also affect billing. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsIndexesApi/index.html b/v1/LogsIndexesApi/index.html index fd0639970d..140bba052f 100644 --- a/v1/LogsIndexesApi/index.html +++ b/v1/LogsIndexesApi/index.html @@ -226,4 +226,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsIndexesApi->update_logs_index_order: %s\n" % e) -

Parameters

Name Type Description Notes
body LogsIndexesOrder Object containing the new ordered list of index names

Return type

LogsIndexesOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body LogsIndexesOrder Object containing the new ordered list of index names

Return type

LogsIndexesOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsIndexesOrder/index.html b/v1/LogsIndexesOrder/index.html index 4cb9ad8a7b..c83f636411 100644 --- a/v1/LogsIndexesOrder/index.html +++ b/v1/LogsIndexesOrder/index.html @@ -1 +1 @@ - LogsIndexesOrder - Datadog API Client for Python

LogsIndexesOrder

Object containing the ordered list of log index names.

Properties

Name Type Description Notes
index_names [str] Array of strings identifying by their name(s) the index(es) of your organization. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsIndexesOrder - Datadog API Client for Python

LogsIndexesOrder

Object containing the ordered list of log index names.

Properties

Name Type Description Notes
index_names [str] Array of strings identifying by their name(s) the index(es) of your organization. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsListRequest/index.html b/v1/LogsListRequest/index.html index 7cae78648e..f0553e9d68 100644 --- a/v1/LogsListRequest/index.html +++ b/v1/LogsListRequest/index.html @@ -1 +1 @@ - LogsListRequest - Datadog API Client for Python

LogsListRequest

Object to send with the request to retrieve a list of logs from your Organization.

Properties

Name Type Description Notes
time LogsListRequestTime
index str The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. [optional]
limit int Number of logs return in the response. [optional]
query str The search query - following the log search syntax. [optional]
sort LogsSort [optional]
start_at str Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 18, 2020
\ No newline at end of file + LogsListRequest - Datadog API Client for Python

LogsListRequest

Object to send with the request to retrieve a list of logs from your Organization.

Properties

Name Type Description Notes
time LogsListRequestTime
index str The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. [optional]
limit int Number of logs return in the response. [optional]
query str The search query - following the log search syntax. [optional]
sort LogsSort [optional]
start_at str Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsListRequestTime/index.html b/v1/LogsListRequestTime/index.html index f649048d77..e3bbcb7451 100644 --- a/v1/LogsListRequestTime/index.html +++ b/v1/LogsListRequestTime/index.html @@ -1 +1 @@ - LogsListRequestTime - Datadog API Client for Python

LogsListRequestTime

Timeframe to retrieve the log from.

Properties

Name Type Description Notes
_from datetime Minimum timestamp for requested logs.
to datetime Maximum timestamp for requested logs.
timezone str Timezone can be specified both as an offset (e.g. \"UTC+03:00\") or a regional zone (e.g. \"Europe/Paris\"). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsListRequestTime - Datadog API Client for Python

LogsListRequestTime

Timeframe to retrieve the log from.

Properties

Name Type Description Notes
_from datetime Minimum timestamp for requested logs.
to datetime Maximum timestamp for requested logs.
timezone str Timezone can be specified both as an offset (e.g. \"UTC+03:00\") or a regional zone (e.g. \"Europe/Paris\"). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsListResponse/index.html b/v1/LogsListResponse/index.html index 63211941ab..22eb032a88 100644 --- a/v1/LogsListResponse/index.html +++ b/v1/LogsListResponse/index.html @@ -1 +1 @@ - LogsListResponse - Datadog API Client for Python

LogsListResponse

Response object with all logs matching the request and pagination information.

Properties

Name Type Description Notes
logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional]
next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional]
status str Status of the response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsListResponse - Datadog API Client for Python

LogsListResponse

Response object with all logs matching the request and pagination information.

Properties

Name Type Description Notes
logs [Log] Array of logs matching the request and the `nextLogId` if sent. [optional]
next_log_id str Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. [optional]
status str Status of the response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsLookupProcessor/index.html b/v1/LogsLookupProcessor/index.html index 5d1bec8e4a..b24349d882 100644 --- a/v1/LogsLookupProcessor/index.html +++ b/v1/LogsLookupProcessor/index.html @@ -1 +1 @@ - LogsLookupProcessor - Datadog API Client for Python

LogsLookupProcessor

Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.

Properties

Name Type Description Notes
lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]`
source str Source attribute used to perform the lookup.
target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list.
type LogsLookupProcessorType
default_lookup str Value to set the target attribute if the source value is not found in the list. [optional]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsLookupProcessor - Datadog API Client for Python

LogsLookupProcessor

Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.

Properties

Name Type Description Notes
lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]`
source str Source attribute used to perform the lookup.
target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list.
type LogsLookupProcessorType
default_lookup str Value to set the target attribute if the source value is not found in the list. [optional]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsLookupProcessorType/index.html b/v1/LogsLookupProcessorType/index.html index 4eda5f0701..93dcf2b444 100644 --- a/v1/LogsLookupProcessorType/index.html +++ b/v1/LogsLookupProcessorType/index.html @@ -1 +1 @@ - LogsLookupProcessorType - Datadog API Client for Python

LogsLookupProcessorType

Type of logs lookup processor.

Properties

Name Type Description Notes
value str Type of logs lookup processor. defaults to "lookup-processor", must be one of ["lookup-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsLookupProcessorType - Datadog API Client for Python

LogsLookupProcessorType

Type of logs lookup processor.

Properties

Name Type Description Notes
value str Type of logs lookup processor. defaults to "lookup-processor", must be one of ["lookup-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsMessageRemapper/index.html b/v1/LogsMessageRemapper/index.html index 23444680ce..f0b03acf8f 100644 --- a/v1/LogsMessageRemapper/index.html +++ b/v1/LogsMessageRemapper/index.html @@ -1 +1 @@ - LogsMessageRemapper - Datadog API Client for Python

LogsMessageRemapper

The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.

Properties

Name Type Description Notes
type LogsMessageRemapperType
sources [str] Array of source attributes. defaults to ["msg"]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsMessageRemapper - Datadog API Client for Python

LogsMessageRemapper

The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.

Properties

Name Type Description Notes
type LogsMessageRemapperType
sources [str] Array of source attributes. defaults to ["msg"]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsMessageRemapperType/index.html b/v1/LogsMessageRemapperType/index.html index 0ee6e320ac..c9a9357eb9 100644 --- a/v1/LogsMessageRemapperType/index.html +++ b/v1/LogsMessageRemapperType/index.html @@ -1 +1 @@ - LogsMessageRemapperType - Datadog API Client for Python

LogsMessageRemapperType

Type of logs message remapper.

Properties

Name Type Description Notes
value str Type of logs message remapper. defaults to "message-remapper", must be one of ["message-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsMessageRemapperType - Datadog API Client for Python

LogsMessageRemapperType

Type of logs message remapper.

Properties

Name Type Description Notes
value str Type of logs message remapper. defaults to "message-remapper", must be one of ["message-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsPipeline/index.html b/v1/LogsPipeline/index.html index dddebfe88c..5e812051f9 100644 --- a/v1/LogsPipeline/index.html +++ b/v1/LogsPipeline/index.html @@ -1 +1 @@ - LogsPipeline - Datadog API Client for Python

LogsPipeline

Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note: These endpoints are only available for admin users. Make sure to use an application key created by an admin.

Properties

Name Type Description Notes
name str Name of the pipeline.
filter LogsFilter [optional]
id str ID of the pipeline. [optional][readonly]
is_enabled bool Whether or not the pipeline is enabled. [optional]
is_read_only bool Whether or not the pipeline can be edited. [optional][readonly]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]
type str Type of pipeline. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsPipeline - Datadog API Client for Python

LogsPipeline

Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note: These endpoints are only available for admin users. Make sure to use an application key created by an admin.

Properties

Name Type Description Notes
name str Name of the pipeline.
filter LogsFilter [optional]
id str ID of the pipeline. [optional][readonly]
is_enabled bool Whether or not the pipeline is enabled. [optional]
is_read_only bool Whether or not the pipeline can be edited. [optional][readonly]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]
type str Type of pipeline. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsPipelineList/index.html b/v1/LogsPipelineList/index.html index c49dc58b2a..a2f221ac4e 100644 --- a/v1/LogsPipelineList/index.html +++ b/v1/LogsPipelineList/index.html @@ -1 +1 @@ - LogsPipelineList - Datadog API Client for Python
\ No newline at end of file + LogsPipelineList - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsPipelineProcessor/index.html b/v1/LogsPipelineProcessor/index.html index ade6489629..33ecab6bdb 100644 --- a/v1/LogsPipelineProcessor/index.html +++ b/v1/LogsPipelineProcessor/index.html @@ -1 +1 @@ - LogsPipelineProcessor - Datadog API Client for Python

LogsPipelineProcessor

Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors.

Properties

Name Type Description Notes
type LogsPipelineProcessorType
filter LogsFilter [optional]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsPipelineProcessor - Datadog API Client for Python

LogsPipelineProcessor

Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors.

Properties

Name Type Description Notes
type LogsPipelineProcessorType
filter LogsFilter [optional]
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsPipelineProcessorType/index.html b/v1/LogsPipelineProcessorType/index.html index 1c0a3d9a61..08155b741d 100644 --- a/v1/LogsPipelineProcessorType/index.html +++ b/v1/LogsPipelineProcessorType/index.html @@ -1 +1 @@ - LogsPipelineProcessorType - Datadog API Client for Python

LogsPipelineProcessorType

Type of logs pipeline processor.

Properties

Name Type Description Notes
value str Type of logs pipeline processor. defaults to "pipeline", must be one of ["pipeline", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsPipelineProcessorType - Datadog API Client for Python

LogsPipelineProcessorType

Type of logs pipeline processor.

Properties

Name Type Description Notes
value str Type of logs pipeline processor. defaults to "pipeline", must be one of ["pipeline", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsPipelinesApi/index.html b/v1/LogsPipelinesApi/index.html index 6b3fc9aeaa..13f910b420 100644 --- a/v1/LogsPipelinesApi/index.html +++ b/v1/LogsPipelinesApi/index.html @@ -246,4 +246,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\n" % e) -

Parameters

Name Type Description Notes
body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs.

Return type

LogsPipelinesOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body LogsPipelinesOrder Object containing the new ordered list of pipeline IDs.

Return type

LogsPipelinesOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsPipelinesOrder/index.html b/v1/LogsPipelinesOrder/index.html index 74f2b6e87d..55c9edc981 100644 --- a/v1/LogsPipelinesOrder/index.html +++ b/v1/LogsPipelinesOrder/index.html @@ -1 +1 @@ - LogsPipelinesOrder - Datadog API Client for Python

LogsPipelinesOrder

Object containing the ordered list of pipeline IDs.

Properties

Name Type Description Notes
pipeline_ids [str] Ordered Array of `<PIPELINE_ID>` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsPipelinesOrder - Datadog API Client for Python

LogsPipelinesOrder

Object containing the ordered list of pipeline IDs.

Properties

Name Type Description Notes
pipeline_ids [str] Ordered Array of `<PIPELINE_ID>` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsProcessor/index.html b/v1/LogsProcessor/index.html index 521f99d90b..979022eb86 100644 --- a/v1/LogsProcessor/index.html +++ b/v1/LogsProcessor/index.html @@ -1 +1 @@ - LogsProcessor - Datadog API Client for Python

LogsProcessor

Definition of a logs processor.

Properties

Name Type Description Notes
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
samples [str] List of sample logs to test this grok parser. [optional]
override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False
preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False
source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
target_format TargetFormatType [optional]
target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False
is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False
is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False
filter LogsFilter [optional]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]
default_lookup str Value to set the target attribute if the source value is not found in the list. [optional]
grok LogsGrokParserRules [optional]
source str Source attribute used to perform the lookup. [optional]
type LogsTraceRemapperType [optional]
sources [str] Array of source attributes. [optional] if omitted the server will use the default value of ["dd.trace_id"]
target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional]
categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional]
expression str Arithmetic operation between one or more log attributes. [optional]
template str A formula with one or more attributes and raw text. [optional]
lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]` [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + LogsProcessor - Datadog API Client for Python

LogsProcessor

Definition of a logs processor.

Properties

Name Type Description Notes
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
samples [str] List of sample logs to test this grok parser. [optional]
override_on_conflict bool Override or not the target element if already set, [optional] if omitted the server will use the default value of False
preserve_source bool Remove or preserve the remapped source element. [optional] if omitted the server will use the default value of False
source_type str Defines if the sources are from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
target_format TargetFormatType [optional]
target_type str Defines if the final attribute or tag name is from log `attribute` or `tag`. [optional] if omitted the server will use the default value of "attribute"
normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False
is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False
is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False
filter LogsFilter [optional]
processors [LogsProcessor] Ordered list of processors in this pipeline. [optional]
default_lookup str Value to set the target attribute if the source value is not found in the list. [optional]
grok LogsGrokParserRules [optional]
source str Source attribute used to perform the lookup. [optional]
type LogsTraceRemapperType [optional]
sources [str] Array of source attributes. [optional] if omitted the server will use the default value of ["dd.trace_id"]
target str Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. [optional]
categories [LogsCategoryProcessorCategory] Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. [optional]
expression str Arithmetic operation between one or more log attributes. [optional]
template str A formula with one or more attributes and raw text. [optional]
lookup_table [str] Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]` [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsQueryCompute/index.html b/v1/LogsQueryCompute/index.html index e09756d18d..f362a29ec0 100644 --- a/v1/LogsQueryCompute/index.html +++ b/v1/LogsQueryCompute/index.html @@ -1 +1 @@ - LogsQueryCompute - Datadog API Client for Python

LogsQueryCompute

Define computation for a log query.

Properties

Name Type Description Notes
aggregation str The aggregation method.
facet str Facet name. [optional]
interval int Define a time interval in seconds. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsQueryCompute - Datadog API Client for Python

LogsQueryCompute

Define computation for a log query.

Properties

Name Type Description Notes
aggregation str The aggregation method.
facet str Facet name. [optional]
interval int Define a time interval in seconds. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsServiceRemapper/index.html b/v1/LogsServiceRemapper/index.html index a945a70941..c91ef4fdda 100644 --- a/v1/LogsServiceRemapper/index.html +++ b/v1/LogsServiceRemapper/index.html @@ -1 +1 @@ - LogsServiceRemapper - Datadog API Client for Python

LogsServiceRemapper

Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsServiceRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsServiceRemapper - Datadog API Client for Python

LogsServiceRemapper

Use this processor if you want to assign one or more attributes as the official service. Note: If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsServiceRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsServiceRemapperType/index.html b/v1/LogsServiceRemapperType/index.html index 3c7eb4d921..f4b2d5e94e 100644 --- a/v1/LogsServiceRemapperType/index.html +++ b/v1/LogsServiceRemapperType/index.html @@ -1 +1 @@ - LogsServiceRemapperType - Datadog API Client for Python

LogsServiceRemapperType

Type of logs service remapper.

Properties

Name Type Description Notes
value str Type of logs service remapper. defaults to "service-remapper", must be one of ["service-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsServiceRemapperType - Datadog API Client for Python

LogsServiceRemapperType

Type of logs service remapper.

Properties

Name Type Description Notes
value str Type of logs service remapper. defaults to "service-remapper", must be one of ["service-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsSort/index.html b/v1/LogsSort/index.html index f99c19b4d1..9c0b999dc3 100644 --- a/v1/LogsSort/index.html +++ b/v1/LogsSort/index.html @@ -1 +1 @@ - LogsSort - Datadog API Client for Python

LogsSort

Time-ascending asc or time-descending descresults.

Properties

Name Type Description Notes
value str Time-ascending `asc` or time-descending `desc`results. must be one of ["asc", "desc", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsSort - Datadog API Client for Python

LogsSort

Time-ascending asc or time-descending descresults.

Properties

Name Type Description Notes
value str Time-ascending `asc` or time-descending `desc`results. must be one of ["asc", "desc", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsStatusRemapper/index.html b/v1/LogsStatusRemapper/index.html index cbf49227e5..5e15e762ee 100644 --- a/v1/LogsStatusRemapper/index.html +++ b/v1/LogsStatusRemapper/index.html @@ -1 +1 @@ - LogsStatusRemapper - Datadog API Client for Python

LogsStatusRemapper

Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d, trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsStatusRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsStatusRemapper - Datadog API Client for Python

LogsStatusRemapper

Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d, trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

Properties

Name Type Description Notes
sources [str] Array of source attributes.
type LogsStatusRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsStatusRemapperType/index.html b/v1/LogsStatusRemapperType/index.html index 248e50a573..949d6279b9 100644 --- a/v1/LogsStatusRemapperType/index.html +++ b/v1/LogsStatusRemapperType/index.html @@ -1 +1 @@ - LogsStatusRemapperType - Datadog API Client for Python

LogsStatusRemapperType

Type of logs status remapper.

Properties

Name Type Description Notes
value str Type of logs status remapper. defaults to "status-remapper", must be one of ["status-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsStatusRemapperType - Datadog API Client for Python

LogsStatusRemapperType

Type of logs status remapper.

Properties

Name Type Description Notes
value str Type of logs status remapper. defaults to "status-remapper", must be one of ["status-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsStringBuilderProcessor/index.html b/v1/LogsStringBuilderProcessor/index.html index 0a495aefd9..f3068a892c 100644 --- a/v1/LogsStringBuilderProcessor/index.html +++ b/v1/LogsStringBuilderProcessor/index.html @@ -1 +1 @@ - LogsStringBuilderProcessor - Datadog API Client for Python

LogsStringBuilderProcessor

Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path}. Notes: - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters.

Properties

Name Type Description Notes
target str The name of the attribute that contains the result of the template.
template str A formula with one or more attributes and raw text.
type LogsStringBuilderProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsStringBuilderProcessor - Datadog API Client for Python

LogsStringBuilderProcessor

Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path}. Notes: - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters.

Properties

Name Type Description Notes
target str The name of the attribute that contains the result of the template.
template str A formula with one or more attributes and raw text.
type LogsStringBuilderProcessorType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_replace_missing bool If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsStringBuilderProcessorType/index.html b/v1/LogsStringBuilderProcessorType/index.html index 981c8dba52..2390d72941 100644 --- a/v1/LogsStringBuilderProcessorType/index.html +++ b/v1/LogsStringBuilderProcessorType/index.html @@ -1 +1 @@ - LogsStringBuilderProcessorType - Datadog API Client for Python

LogsStringBuilderProcessorType

Type of logs string builder processor.

Properties

Name Type Description Notes
value str Type of logs string builder processor. defaults to "string-builder-processor", must be one of ["string-builder-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsStringBuilderProcessorType - Datadog API Client for Python

LogsStringBuilderProcessorType

Type of logs string builder processor.

Properties

Name Type Description Notes
value str Type of logs string builder processor. defaults to "string-builder-processor", must be one of ["string-builder-processor", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsTraceRemapper/index.html b/v1/LogsTraceRemapper/index.html index 212a372765..bc691d956b 100644 --- a/v1/LogsTraceRemapper/index.html +++ b/v1/LogsTraceRemapper/index.html @@ -1 +1 @@ - LogsTraceRemapper - Datadog API Client for Python

LogsTraceRemapper

There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID.

Properties

Name Type Description Notes
type LogsTraceRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
sources [str] Array of source attributes. [optional] if omitted the server will use the default value of ["dd.trace_id"]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsTraceRemapper - Datadog API Client for Python

LogsTraceRemapper

There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID.

Properties

Name Type Description Notes
type LogsTraceRemapperType
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
sources [str] Array of source attributes. [optional] if omitted the server will use the default value of ["dd.trace_id"]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsTraceRemapperType/index.html b/v1/LogsTraceRemapperType/index.html index e53b4b9eb8..e44437bd07 100644 --- a/v1/LogsTraceRemapperType/index.html +++ b/v1/LogsTraceRemapperType/index.html @@ -1 +1 @@ - LogsTraceRemapperType - Datadog API Client for Python

LogsTraceRemapperType

Type of logs trace remapper.

Properties

Name Type Description Notes
value str Type of logs trace remapper. defaults to "trace-id-remapper", must be one of ["trace-id-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsTraceRemapperType - Datadog API Client for Python

LogsTraceRemapperType

Type of logs trace remapper.

Properties

Name Type Description Notes
value str Type of logs trace remapper. defaults to "trace-id-remapper", must be one of ["trace-id-remapper", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsURLParser/index.html b/v1/LogsURLParser/index.html index efdc1c3842..910a042833 100644 --- a/v1/LogsURLParser/index.html +++ b/v1/LogsURLParser/index.html @@ -1 +1 @@ - LogsURLParser - Datadog API Client for Python

LogsURLParser

This processor extracts query parameters and other important parameters from a URL.

Properties

Name Type Description Notes
type LogsURLParserType
sources [str] Array of source attributes. defaults to ["http.url"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "http.url_details"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsURLParser - Datadog API Client for Python

LogsURLParser

This processor extracts query parameters and other important parameters from a URL.

Properties

Name Type Description Notes
type LogsURLParserType
sources [str] Array of source attributes. defaults to ["http.url"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "http.url_details"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]
normalize_ending_slashes bool, none_type Normalize the ending slashes or not. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsURLParserType/index.html b/v1/LogsURLParserType/index.html index 5d35eb8b74..36e1c45116 100644 --- a/v1/LogsURLParserType/index.html +++ b/v1/LogsURLParserType/index.html @@ -1 +1 @@ - LogsURLParserType - Datadog API Client for Python
\ No newline at end of file + LogsURLParserType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/LogsUserAgentParser/index.html b/v1/LogsUserAgentParser/index.html index c357544227..d86483bb6b 100644 --- a/v1/LogsUserAgentParser/index.html +++ b/v1/LogsUserAgentParser/index.html @@ -1 +1 @@ - LogsUserAgentParser - Datadog API Client for Python

LogsUserAgentParser

The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.

Properties

Name Type Description Notes
type LogsUserAgentParserType
sources [str] Array of source attributes. defaults to ["http.useragent"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "http.useragent_details"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsUserAgentParser - Datadog API Client for Python

LogsUserAgentParser

The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.

Properties

Name Type Description Notes
type LogsUserAgentParserType
sources [str] Array of source attributes. defaults to ["http.useragent"]
target str Name of the parent attribute that contains all the extracted details from the `sources`. defaults to "http.useragent_details"
is_enabled bool Whether or not the processor is enabled. [optional] if omitted the server will use the default value of False
is_encoded bool Define if the source attribute is URL encoded or not. [optional] if omitted the server will use the default value of False
name str Name of the processor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/LogsUserAgentParserType/index.html b/v1/LogsUserAgentParserType/index.html index 9ec25e0b6d..1e099c6204 100644 --- a/v1/LogsUserAgentParserType/index.html +++ b/v1/LogsUserAgentParserType/index.html @@ -1 +1 @@ - LogsUserAgentParserType - Datadog API Client for Python

LogsUserAgentParserType

Type of logs User-Agent parser.

Properties

Name Type Description Notes
value str Type of logs User-Agent parser. defaults to "user-agent-parser", must be one of ["user-agent-parser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsUserAgentParserType - Datadog API Client for Python

LogsUserAgentParserType

Type of logs User-Agent parser.

Properties

Name Type Description Notes
value str Type of logs User-Agent parser. defaults to "user-agent-parser", must be one of ["user-agent-parser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricMetadata/index.html b/v1/MetricMetadata/index.html index 7c71e2d8cd..0f05fa13ef 100644 --- a/v1/MetricMetadata/index.html +++ b/v1/MetricMetadata/index.html @@ -1 +1 @@ - MetricMetadata - Datadog API Client for Python

MetricMetadata

Object with all metric related metadata.

Properties

Name Type Description Notes
description str Metric description. [optional]
integration str Name of the integration that sent the metric if applicable. [optional][readonly]
per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional]
short_name str A more human-readable and abbreviated version of the metric name. [optional]
statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional]
type str Metric type such as `gauge` or `rate`. [optional]
unit str Primary unit of the metric such as `byte` or `operation`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MetricMetadata - Datadog API Client for Python

MetricMetadata

Object with all metric related metadata.

Properties

Name Type Description Notes
description str Metric description. [optional]
integration str Name of the integration that sent the metric if applicable. [optional][readonly]
per_unit str Per unit of the metric such as `second` in `bytes per second`. [optional]
short_name str A more human-readable and abbreviated version of the metric name. [optional]
statsd_interval int StatsD flush interval of the metric in seconds if applicable. [optional]
type str Metric type such as `gauge` or `rate`. [optional]
unit str Primary unit of the metric such as `byte` or `operation`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricSearchResponse/index.html b/v1/MetricSearchResponse/index.html index 43ec8d8cfe..135549dc78 100644 --- a/v1/MetricSearchResponse/index.html +++ b/v1/MetricSearchResponse/index.html @@ -1 +1 @@ - MetricSearchResponse - Datadog API Client for Python
\ No newline at end of file + MetricSearchResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/MetricSearchResponseResults/index.html b/v1/MetricSearchResponseResults/index.html index 807e9c92cb..45b44f870f 100644 --- a/v1/MetricSearchResponseResults/index.html +++ b/v1/MetricSearchResponseResults/index.html @@ -1 +1 @@ - MetricSearchResponseResults - Datadog API Client for Python
\ No newline at end of file + MetricSearchResponseResults - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/MetricsApi/index.html b/v1/MetricsApi/index.html index 7dba88549d..4d1c492f7e 100644 --- a/v1/MetricsApi/index.html +++ b/v1/MetricsApi/index.html @@ -179,4 +179,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling MetricsApi->update_metric_metadata: %s\n" % e) -

Parameters

Name Type Description Notes
metric_name str Name of the metric for which to edit metadata.
body MetricMetadata New metadata.

Return type

MetricMetadata

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
metric_name str Name of the metric for which to edit metadata.
body MetricMetadata New metadata.

Return type

MetricMetadata

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricsListResponse/index.html b/v1/MetricsListResponse/index.html index 0f909d6cce..c3d838d00d 100644 --- a/v1/MetricsListResponse/index.html +++ b/v1/MetricsListResponse/index.html @@ -1 +1 @@ - MetricsListResponse - Datadog API Client for Python

MetricsListResponse

Object listing all metric names stored by Datadog since a given time.

Properties

Name Type Description Notes
_from str Time when the metrics were active, seconds since the Unix epoch. [optional]
metrics [str] List of metric names. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MetricsListResponse - Datadog API Client for Python

MetricsListResponse

Object listing all metric names stored by Datadog since a given time.

Properties

Name Type Description Notes
_from str Time when the metrics were active, seconds since the Unix epoch. [optional]
metrics [str] List of metric names. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricsQueryMetadata/index.html b/v1/MetricsQueryMetadata/index.html index 0bede0549c..f9b01b4ddb 100644 --- a/v1/MetricsQueryMetadata/index.html +++ b/v1/MetricsQueryMetadata/index.html @@ -1 +1 @@ - MetricsQueryMetadata - Datadog API Client for Python

MetricsQueryMetadata

Object containing all metric names returned and their associated metadata.

Properties

Name Type Description Notes
aggr str Aggregation type. [optional][readonly]
display_name str Display name of the metric. [optional][readonly]
end int End of the time window, milliseconds since Unix epoch. [optional][readonly]
expression str Metric expression. [optional][readonly]
interval int Number of seconds between data samples. [optional][readonly]
length int Number of data samples. [optional][readonly]
metric str Metric name. [optional][readonly]
pointlist [Point] List of points of the time series. [optional][readonly]
scope str Metric scope, comma separated list of tags. [optional][readonly]
start int Start of the time window, milliseconds since Unix epoch. [optional][readonly]
unit [MetricsQueryUnit] Detailed information about the metric unit. First element describes the \"primary unit\" (for example, `bytes` in `bytes per second`), second describes the \"per unit\" (for example, `second` in `bytes per second`). [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + MetricsQueryMetadata - Datadog API Client for Python

MetricsQueryMetadata

Object containing all metric names returned and their associated metadata.

Properties

Name Type Description Notes
aggr str Aggregation type. [optional][readonly]
display_name str Display name of the metric. [optional][readonly]
end int End of the time window, milliseconds since Unix epoch. [optional][readonly]
expression str Metric expression. [optional][readonly]
interval int Number of seconds between data samples. [optional][readonly]
length int Number of data samples. [optional][readonly]
metric str Metric name. [optional][readonly]
pointlist [Point] List of points of the time series. [optional][readonly]
scope str Metric scope, comma separated list of tags. [optional][readonly]
start int Start of the time window, milliseconds since Unix epoch. [optional][readonly]
unit [MetricsQueryUnit] Detailed information about the metric unit. First element describes the \"primary unit\" (for example, `bytes` in `bytes per second`), second describes the \"per unit\" (for example, `second` in `bytes per second`). [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricsQueryResponse/index.html b/v1/MetricsQueryResponse/index.html index f01db1a8a0..1f4aaf4220 100644 --- a/v1/MetricsQueryResponse/index.html +++ b/v1/MetricsQueryResponse/index.html @@ -1 +1 @@ - MetricsQueryResponse - Datadog API Client for Python

MetricsQueryResponse

Response Object that includes your query and the list of metrics retrieved.

Properties

Name Type Description Notes
error str Message indicating the errors if status is not `ok`. [optional][readonly]
from_date int Start of requested time window, milliseconds since Unix epoch. [optional][readonly]
group_by [str] List of tag keys on which to group. [optional][readonly]
message str Message indicating `success` if status is `ok`. [optional][readonly]
query str Query string [optional][readonly]
res_type str Type of response. [optional][readonly]
series [MetricsQueryMetadata] List of timeseries queried. [optional][readonly]
status str Status of the query. [optional][readonly]
to_date int End of requested time window, milliseconds since Unix epoch. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + MetricsQueryResponse - Datadog API Client for Python

MetricsQueryResponse

Response Object that includes your query and the list of metrics retrieved.

Properties

Name Type Description Notes
error str Message indicating the errors if status is not `ok`. [optional][readonly]
from_date int Start of requested time window, milliseconds since Unix epoch. [optional][readonly]
group_by [str] List of tag keys on which to group. [optional][readonly]
message str Message indicating `success` if status is `ok`. [optional][readonly]
query str Query string [optional][readonly]
res_type str Type of response. [optional][readonly]
series [MetricsQueryMetadata] List of timeseries queried. [optional][readonly]
status str Status of the query. [optional][readonly]
to_date int End of requested time window, milliseconds since Unix epoch. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MetricsQueryUnit/index.html b/v1/MetricsQueryUnit/index.html index e695a20897..a06016ea51 100644 --- a/v1/MetricsQueryUnit/index.html +++ b/v1/MetricsQueryUnit/index.html @@ -1 +1 @@ - MetricsQueryUnit - Datadog API Client for Python

MetricsQueryUnit

Object containing the metric unit family, scale factor, name, and short name.

Properties

Name Type Description Notes
family str Unit family, allows for conversion between units of the same family, for scaling. [optional][readonly]
name str Unit name [optional][readonly]
plural str Plural form of the unit name. [optional][readonly]
scale_factor float Factor for scaling between units of the same family. [optional][readonly]
short_name str Abbreviation of the unit. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + MetricsQueryUnit - Datadog API Client for Python

MetricsQueryUnit

Object containing the metric unit family, scale factor, name, and short name.

Properties

Name Type Description Notes
family str Unit family, allows for conversion between units of the same family, for scaling. [optional][readonly]
name str Unit name [optional][readonly]
plural str Plural form of the unit name. [optional][readonly]
scale_factor float Factor for scaling between units of the same family. [optional][readonly]
short_name str Abbreviation of the unit. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Monitor/index.html b/v1/Monitor/index.html index 608fd5e971..580ed0fa96 100644 --- a/v1/Monitor/index.html +++ b/v1/Monitor/index.html @@ -1 +1 @@ - Monitor - Datadog API Client for Python

Monitor

Object describing a monitor.

Properties

Name Type Description Notes
created datetime Timestamp of the monitor creation. [optional][readonly]
creator Creator [optional]
deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) [optional][readonly]
id int ID of this monitor. [optional][readonly]
message str A message to include with notifications for this monitor. [optional]
modified datetime Last timestamp when the monitor was edited. [optional][readonly]
multi bool Whether or not the monitor is broken down on different groups. [optional][readonly]
name str The monitor name. [optional]
options MonitorOptions [optional]
overall_state MonitorOverallStates [optional]
priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional]
query str The monitor query. [optional]
restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional]
state MonitorState [optional]
tags [str] Tags associated to your monitor. [optional]
type MonitorType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 29, 2021
\ No newline at end of file + Monitor - Datadog API Client for Python

Monitor

Object describing a monitor.

Properties

Name Type Description Notes
created datetime Timestamp of the monitor creation. [optional][readonly]
creator Creator [optional]
deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) [optional][readonly]
id int ID of this monitor. [optional][readonly]
message str A message to include with notifications for this monitor. [optional]
modified datetime Last timestamp when the monitor was edited. [optional][readonly]
multi bool Whether or not the monitor is broken down on different groups. [optional][readonly]
name str The monitor name. [optional]
options MonitorOptions [optional]
overall_state MonitorOverallStates [optional]
priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional]
query str The monitor query. [optional]
restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional]
state MonitorState [optional]
tags [str] Tags associated to your monitor. [optional]
type MonitorType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorDeviceID/index.html b/v1/MonitorDeviceID/index.html index 89a09fdb37..e2df289300 100644 --- a/v1/MonitorDeviceID/index.html +++ b/v1/MonitorDeviceID/index.html @@ -1 +1 @@ - MonitorDeviceID - Datadog API Client for Python

MonitorDeviceID

ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID.

Properties

Name Type Description Notes
value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of ["laptop_large", "tablet", "mobile_small", "chrome.laptop_large", "chrome.tablet", "chrome.mobile_small", "firefox.laptop_large", "firefox.tablet", "firefox.mobile_small", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorDeviceID - Datadog API Client for Python

MonitorDeviceID

ID of the device the Synthetics monitor is running on. Same as SyntheticsDeviceID.

Properties

Name Type Description Notes
value str ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. must be one of ["laptop_large", "tablet", "mobile_small", "chrome.laptop_large", "chrome.tablet", "chrome.mobile_small", "firefox.laptop_large", "firefox.tablet", "firefox.mobile_small", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorOptions/index.html b/v1/MonitorOptions/index.html index b3757cb67e..50d2127b6b 100644 --- a/v1/MonitorOptions/index.html +++ b/v1/MonitorOptions/index.html @@ -1 +1 @@ - MonitorOptions - Datadog API Client for Python

MonitorOptions

List of options associated with your monitor.

Properties

Name Type Description Notes
aggregation MonitorOptionsAggregation [optional]
device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. [optional][readonly]
enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional]
escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of "none"
evaluation_delay int, none_type Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. [optional]
groupby_simple_monitor bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional]
include_tags bool A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. Examples - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` [optional] if omitted the server will use the default value of True
locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional]
min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0
min_location_failed int, none_type The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1). [optional] if omitted the server will use the default value of 1
new_host_delay int, none_type Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. [optional] if omitted the server will use the default value of 300
no_data_timeframe int, none_type The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for metric alerts, and 24 hours is used for service checks. [optional]
notify_audit bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False
notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False
renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. [optional]
require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional]
silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional]
synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional]
threshold_windows MonitorThresholdWindowOptions [optional]
thresholds MonitorThresholds [optional]
timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 1, 2021
\ No newline at end of file + MonitorOptions - Datadog API Client for Python

MonitorOptions

List of options associated with your monitor.

Properties

Name Type Description Notes
aggregation MonitorOptionsAggregation [optional]
device_ids [MonitorDeviceID] IDs of the device the Synthetics monitor is running on. [optional][readonly]
enable_logs_sample bool Whether or not to send a log sample when the log monitor triggers. [optional]
escalation_message str A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. [optional] if omitted the server will use the default value of "none"
evaluation_delay int, none_type Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. [optional]
groupby_simple_monitor bool Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. [optional]
include_tags bool A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. Examples - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` [optional] if omitted the server will use the default value of True
locked bool Whether or not the monitor is locked (only editable by creator and admins). [optional]
min_failure_duration int, none_type How long the test should be in failure before alerting (integer, number of seconds, max 7200). [optional] if omitted the server will use the default value of 0
min_location_failed int, none_type The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1). [optional] if omitted the server will use the default value of 1
new_host_delay int, none_type Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. [optional] if omitted the server will use the default value of 300
no_data_timeframe int, none_type The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for metric alerts, and 24 hours is used for service checks. [optional]
notify_audit bool A Boolean indicating whether tagged users is notified on changes to this monitor. [optional] if omitted the server will use the default value of False
notify_no_data bool A Boolean indicating whether this monitor notifies when data stops reporting. [optional] if omitted the server will use the default value of False
renotify_interval int, none_type The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. [optional]
require_full_window bool A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. [optional]
silenced {str: (int, none_type)} Information about the downtime applied to the monitor. [optional]
synthetics_check_id str, none_type ID of the corresponding Synthetic check. [optional]
threshold_windows MonitorThresholdWindowOptions [optional]
thresholds MonitorThresholds [optional]
timeout_h int, none_type The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorOptionsAggregation/index.html b/v1/MonitorOptionsAggregation/index.html index ddc29d04c4..b397b4f065 100644 --- a/v1/MonitorOptionsAggregation/index.html +++ b/v1/MonitorOptionsAggregation/index.html @@ -1 +1 @@ - MonitorOptionsAggregation - Datadog API Client for Python

MonitorOptionsAggregation

Type of aggregation performed in the monitor query.

Properties

Name Type Description Notes
group_by str Group to break down the monitor on. [optional]
metric str Metric name used in the monitor. [optional]
type str Metric type used in the monitor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorOptionsAggregation - Datadog API Client for Python

MonitorOptionsAggregation

Type of aggregation performed in the monitor query.

Properties

Name Type Description Notes
group_by str Group to break down the monitor on. [optional]
metric str Metric name used in the monitor. [optional]
type str Metric type used in the monitor. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorOverallStates/index.html b/v1/MonitorOverallStates/index.html index 8a80d04862..8db198b521 100644 --- a/v1/MonitorOverallStates/index.html +++ b/v1/MonitorOverallStates/index.html @@ -1 +1 @@ - MonitorOverallStates - Datadog API Client for Python

MonitorOverallStates

The different states your monitor can be in.

Properties

Name Type Description Notes
value str The different states your monitor can be in. must be one of ["Alert", "Ignored", "No Data", "OK", "Skipped", "Unknown", "Warn", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorOverallStates - Datadog API Client for Python

MonitorOverallStates

The different states your monitor can be in.

Properties

Name Type Description Notes
value str The different states your monitor can be in. must be one of ["Alert", "Ignored", "No Data", "OK", "Skipped", "Unknown", "Warn", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorState/index.html b/v1/MonitorState/index.html index 47fd2ea291..292a87a13f 100644 --- a/v1/MonitorState/index.html +++ b/v1/MonitorState/index.html @@ -1 +1 @@ - MonitorState - Datadog API Client for Python
\ No newline at end of file + MonitorState - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/MonitorStateGroup/index.html b/v1/MonitorStateGroup/index.html index b91f930192..237f97ed9d 100644 --- a/v1/MonitorStateGroup/index.html +++ b/v1/MonitorStateGroup/index.html @@ -1 +1 @@ - MonitorStateGroup - Datadog API Client for Python

MonitorStateGroup

Monitor state for a single group.

Properties

Name Type Description Notes
last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional]
last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional]
last_resolved_ts int Latest timestamp the monitor group was resolved. [optional]
last_triggered_ts int Latest timestamp the monitor group triggered. [optional]
name str The name of the monitor. [optional]
status MonitorOverallStates [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorStateGroup - Datadog API Client for Python

MonitorStateGroup

Monitor state for a single group.

Properties

Name Type Description Notes
last_nodata_ts int Latest timestamp the monitor was in NO_DATA state. [optional]
last_notified_ts int Latest timestamp of the notification sent for this monitor group. [optional]
last_resolved_ts int Latest timestamp the monitor group was resolved. [optional]
last_triggered_ts int Latest timestamp the monitor group triggered. [optional]
name str The name of the monitor. [optional]
status MonitorOverallStates [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorSummaryWidgetDefinition/index.html b/v1/MonitorSummaryWidgetDefinition/index.html index 96c47f5130..9a06b7e0d7 100644 --- a/v1/MonitorSummaryWidgetDefinition/index.html +++ b/v1/MonitorSummaryWidgetDefinition/index.html @@ -1 +1 @@ - MonitorSummaryWidgetDefinition - Datadog API Client for Python

MonitorSummaryWidgetDefinition

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the monitors with.
type MonitorSummaryWidgetDefinitionType
color_preference WidgetColorPreference [optional]
count int The number of monitors to display. [optional]
display_format WidgetMonitorSummaryDisplayFormat [optional]
hide_zero_counts bool Whether to show counts of 0 or not. [optional]
show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional]
sort WidgetMonitorSummarySort [optional]
start int The start of the list. Typically 0. [optional]
summary_type WidgetSummaryType [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorSummaryWidgetDefinition - Datadog API Client for Python

MonitorSummaryWidgetDefinition

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
query str Query to filter the monitors with.
type MonitorSummaryWidgetDefinitionType
color_preference WidgetColorPreference [optional]
count int The number of monitors to display. [optional]
display_format WidgetMonitorSummaryDisplayFormat [optional]
hide_zero_counts bool Whether to show counts of 0 or not. [optional]
show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional]
sort WidgetMonitorSummarySort [optional]
start int The start of the list. Typically 0. [optional]
summary_type WidgetSummaryType [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorSummaryWidgetDefinitionType/index.html b/v1/MonitorSummaryWidgetDefinitionType/index.html index 02b5448ce4..6d15e4c8a3 100644 --- a/v1/MonitorSummaryWidgetDefinitionType/index.html +++ b/v1/MonitorSummaryWidgetDefinitionType/index.html @@ -1 +1 @@ - MonitorSummaryWidgetDefinitionType - Datadog API Client for Python

MonitorSummaryWidgetDefinitionType

Type of the monitor summary widget.

Properties

Name Type Description Notes
value str Type of the monitor summary widget. defaults to "manage_status", must be one of ["manage_status", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + MonitorSummaryWidgetDefinitionType - Datadog API Client for Python

MonitorSummaryWidgetDefinitionType

Type of the monitor summary widget.

Properties

Name Type Description Notes
value str Type of the monitor summary widget. defaults to "manage_status", must be one of ["manage_status", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorThresholdWindowOptions/index.html b/v1/MonitorThresholdWindowOptions/index.html index b44669077c..4c38bfdab5 100644 --- a/v1/MonitorThresholdWindowOptions/index.html +++ b/v1/MonitorThresholdWindowOptions/index.html @@ -1 +1 @@ - MonitorThresholdWindowOptions - Datadog API Client for Python

MonitorThresholdWindowOptions

Alerting time window options.

Properties

Name Type Description Notes
recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional]
trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorThresholdWindowOptions - Datadog API Client for Python

MonitorThresholdWindowOptions

Alerting time window options.

Properties

Name Type Description Notes
recovery_window str, none_type Describes how long an anomalous metric must be normal before the alert recovers. [optional]
trigger_window str, none_type Describes how long a metric must be anomalous before an alert triggers. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorThresholds/index.html b/v1/MonitorThresholds/index.html index fc10379b2a..a43236a29c 100644 --- a/v1/MonitorThresholds/index.html +++ b/v1/MonitorThresholds/index.html @@ -1 +1 @@ - MonitorThresholds - Datadog API Client for Python

MonitorThresholds

List of the different monitor threshold available.

Properties

Name Type Description Notes
critical float The monitor `CRITICAL` threshold. [optional]
critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional]
ok float, none_type The monitor `OK` threshold. [optional]
unknown float, none_type The monitor UNKNOWN threshold. [optional]
warning float, none_type The monitor `WARNING` threshold. [optional]
warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + MonitorThresholds - Datadog API Client for Python

MonitorThresholds

List of the different monitor threshold available.

Properties

Name Type Description Notes
critical float The monitor `CRITICAL` threshold. [optional]
critical_recovery float, none_type The monitor `CRITICAL` recovery threshold. [optional]
ok float, none_type The monitor `OK` threshold. [optional]
unknown float, none_type The monitor UNKNOWN threshold. [optional]
warning float, none_type The monitor `WARNING` threshold. [optional]
warning_recovery float, none_type The monitor `WARNING` recovery threshold. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorType/index.html b/v1/MonitorType/index.html index 3200140f6f..a7fc15d125 100644 --- a/v1/MonitorType/index.html +++ b/v1/MonitorType/index.html @@ -1 +1 @@ - MonitorType - Datadog API Client for Python

MonitorType

The type of the monitor. For more information about type, see the monitor options docs.

Properties

Name Type Description Notes
value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of ["composite", "event alert", "log alert", "metric alert", "process alert", "query alert", "rum alert", "service check", "synthetics alert", "trace-analytics alert", "slo alert", "event-v2 alert", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 22, 2021
\ No newline at end of file + MonitorType - Datadog API Client for Python

MonitorType

The type of the monitor. For more information about type, see the monitor options docs.

Properties

Name Type Description Notes
value str The type of the monitor. For more information about `type`, see the monitor options docs. must be one of ["composite", "event alert", "log alert", "metric alert", "process alert", "query alert", "rum alert", "service check", "synthetics alert", "trace-analytics alert", "slo alert", "event-v2 alert", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorUpdateRequest/index.html b/v1/MonitorUpdateRequest/index.html index 0d60e78443..822113cbc8 100644 --- a/v1/MonitorUpdateRequest/index.html +++ b/v1/MonitorUpdateRequest/index.html @@ -1 +1 @@ - MonitorUpdateRequest - Datadog API Client for Python

MonitorUpdateRequest

Object describing a monitor update request.

Properties

Name Type Description Notes
created datetime Timestamp of the monitor creation. [optional][readonly]
creator Creator [optional]
deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) [optional][readonly]
id int ID of this monitor. [optional][readonly]
message str A message to include with notifications for this monitor. [optional]
modified datetime Last timestamp when the monitor was edited. [optional][readonly]
multi bool Whether or not the monitor is broken down on different groups. [optional][readonly]
name str The monitor name. [optional]
options MonitorOptions [optional]
overall_state MonitorOverallStates [optional]
priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional]
query str The monitor query. [optional]
restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional]
state MonitorState [optional]
tags [str] Tags associated to your monitor. [optional]
type MonitorType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 1, 2021
\ No newline at end of file + MonitorUpdateRequest - Datadog API Client for Python

MonitorUpdateRequest

Object describing a monitor update request.

Properties

Name Type Description Notes
created datetime Timestamp of the monitor creation. [optional][readonly]
creator Creator [optional]
deleted datetime, none_type Whether or not the monitor is deleted. (Always `null`) [optional][readonly]
id int ID of this monitor. [optional][readonly]
message str A message to include with notifications for this monitor. [optional]
modified datetime Last timestamp when the monitor was edited. [optional][readonly]
multi bool Whether or not the monitor is broken down on different groups. [optional][readonly]
name str The monitor name. [optional]
options MonitorOptions [optional]
overall_state MonitorOverallStates [optional]
priority int Integer from 1 (high) to 5 (low) indicating alert severity. [optional]
query str The monitor query. [optional]
restricted_roles [str] A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. [optional]
state MonitorState [optional]
tags [str] Tags associated to your monitor. [optional]
type MonitorType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/MonitorsApi/index.html b/v1/MonitorsApi/index.html index e8ac48a88e..6173c32536 100644 --- a/v1/MonitorsApi/index.html +++ b/v1/MonitorsApi/index.html @@ -481,4 +481,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling MonitorsApi->validate_monitor: %s\n" % e) -

Parameters

Name Type Description Notes
body Monitor Monitor request object

Return type

Monitor

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Invalid JSON -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 3, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body Monitor Monitor request object

Return type

Monitor

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Invalid JSON -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/NoteWidgetDefinition/index.html b/v1/NoteWidgetDefinition/index.html index 03c17b6910..d7233246ec 100644 --- a/v1/NoteWidgetDefinition/index.html +++ b/v1/NoteWidgetDefinition/index.html @@ -1 +1 @@ - NoteWidgetDefinition - Datadog API Client for Python

NoteWidgetDefinition

The notes and links widget is similar to free text widget, but allows for more formatting options.

Properties

Name Type Description Notes
content str Content of the note.
type NoteWidgetDefinitionType
background_color str Background color of the note. [optional]
font_size str Size of the text. [optional]
show_tick bool Whether to show a tick or not. [optional]
text_align WidgetTextAlign [optional]
tick_edge WidgetTickEdge [optional]
tick_pos str Where to position the tick on an edge. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + NoteWidgetDefinition - Datadog API Client for Python

NoteWidgetDefinition

The notes and links widget is similar to free text widget, but allows for more formatting options.

Properties

Name Type Description Notes
content str Content of the note.
type NoteWidgetDefinitionType
background_color str Background color of the note. [optional]
font_size str Size of the text. [optional]
show_tick bool Whether to show a tick or not. [optional]
text_align WidgetTextAlign [optional]
tick_edge WidgetTickEdge [optional]
tick_pos str Where to position the tick on an edge. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/NoteWidgetDefinitionType/index.html b/v1/NoteWidgetDefinitionType/index.html index da2445fe15..d4b84062c5 100644 --- a/v1/NoteWidgetDefinitionType/index.html +++ b/v1/NoteWidgetDefinitionType/index.html @@ -1 +1 @@ - NoteWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + NoteWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/Organization/index.html b/v1/Organization/index.html index 990d46b778..39395b50b7 100644 --- a/v1/Organization/index.html +++ b/v1/Organization/index.html @@ -1 +1 @@ - Organization - Datadog API Client for Python

Organization

Create, edit, and manage organizations.

Properties

Name Type Description Notes
billing OrganizationBilling [optional]
created str Date of the organization creation. [optional][readonly]
description str Description of the organization. [optional]
name str The name of the new child-organization, limited to 32 characters. [optional]
public_id str The `public_id` of the organization you are operating within. [optional]
settings OrganizationSettings [optional]
subscription OrganizationSubscription [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + Organization - Datadog API Client for Python

Organization

Create, edit, and manage organizations.

Properties

Name Type Description Notes
billing OrganizationBilling [optional]
created str Date of the organization creation. [optional][readonly]
description str Description of the organization. [optional]
name str The name of the new child-organization, limited to 32 characters. [optional]
public_id str The `public_id` of the organization you are operating within. [optional]
settings OrganizationSettings [optional]
subscription OrganizationSubscription [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/OrganizationBilling/index.html b/v1/OrganizationBilling/index.html index 7c7aa88c34..37b1254630 100644 --- a/v1/OrganizationBilling/index.html +++ b/v1/OrganizationBilling/index.html @@ -1 +1 @@ - OrganizationBilling - Datadog API Client for Python
\ No newline at end of file + OrganizationBilling - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationCreateBody/index.html b/v1/OrganizationCreateBody/index.html index cd8de2cc70..baa159b865 100644 --- a/v1/OrganizationCreateBody/index.html +++ b/v1/OrganizationCreateBody/index.html @@ -1 +1 @@ - OrganizationCreateBody - Datadog API Client for Python
\ No newline at end of file + OrganizationCreateBody - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationCreateResponse/index.html b/v1/OrganizationCreateResponse/index.html index ea8d94c867..1359ba85d6 100644 --- a/v1/OrganizationCreateResponse/index.html +++ b/v1/OrganizationCreateResponse/index.html @@ -1 +1 @@ - OrganizationCreateResponse - Datadog API Client for Python
\ No newline at end of file + OrganizationCreateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationListResponse/index.html b/v1/OrganizationListResponse/index.html index efab4454c1..cd68d1254c 100644 --- a/v1/OrganizationListResponse/index.html +++ b/v1/OrganizationListResponse/index.html @@ -1 +1 @@ - OrganizationListResponse - Datadog API Client for Python
\ No newline at end of file + OrganizationListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationResponse/index.html b/v1/OrganizationResponse/index.html index 5630597b69..e7d36223e9 100644 --- a/v1/OrganizationResponse/index.html +++ b/v1/OrganizationResponse/index.html @@ -1 +1 @@ - OrganizationResponse - Datadog API Client for Python
\ No newline at end of file + OrganizationResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationSettings/index.html b/v1/OrganizationSettings/index.html index 5baa56225a..c610c6c667 100644 --- a/v1/OrganizationSettings/index.html +++ b/v1/OrganizationSettings/index.html @@ -1 +1 @@ - OrganizationSettings - Datadog API Client for Python

OrganizationSettings

A JSON array of settings.

Properties

Name Type Description Notes
private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional]
saml OrganizationSettingsSaml [optional]
saml_autocreate_access_role AccessRole [optional]
saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional]
saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional]
saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional]
saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional]
saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional]
saml_login_url str URL for SAML logging. [optional]
saml_strict_mode OrganizationSettingsSamlStrictMode [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + OrganizationSettings - Datadog API Client for Python

OrganizationSettings

A JSON array of settings.

Properties

Name Type Description Notes
private_widget_share bool Whether or not the organization users can share widgets outside of Datadog. [optional]
saml OrganizationSettingsSaml [optional]
saml_autocreate_access_role AccessRole [optional]
saml_autocreate_users_domains OrganizationSettingsSamlAutocreateUsersDomains [optional]
saml_can_be_enabled bool Whether or not SAML can be enabled for this organization. [optional]
saml_idp_endpoint str Identity provider endpoint for SAML authentication. [optional]
saml_idp_initiated_login OrganizationSettingsSamlIdpInitiatedLogin [optional]
saml_idp_metadata_uploaded bool Whether or not a SAML identity provider metadata file was provided to the Datadog organization. [optional]
saml_login_url str URL for SAML logging. [optional]
saml_strict_mode OrganizationSettingsSamlStrictMode [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/OrganizationSettingsSaml/index.html b/v1/OrganizationSettingsSaml/index.html index cd870b4c24..41c26693a5 100644 --- a/v1/OrganizationSettingsSaml/index.html +++ b/v1/OrganizationSettingsSaml/index.html @@ -1 +1 @@ - OrganizationSettingsSaml - Datadog API Client for Python

OrganizationSettingsSaml

Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.

Properties

Name Type Description Notes
enabled bool Whether or not SAML is enabled for this organization. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + OrganizationSettingsSaml - Datadog API Client for Python

OrganizationSettingsSaml

Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.

Properties

Name Type Description Notes
enabled bool Whether or not SAML is enabled for this organization. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/OrganizationSettingsSamlAutocreateUsersDomains/index.html b/v1/OrganizationSettingsSamlAutocreateUsersDomains/index.html index 7b29c812a4..aa05f23122 100644 --- a/v1/OrganizationSettingsSamlAutocreateUsersDomains/index.html +++ b/v1/OrganizationSettingsSamlAutocreateUsersDomains/index.html @@ -1 +1 @@ - OrganizationSettingsSamlAutocreateUsersDomains - Datadog API Client for Python

OrganizationSettingsSamlAutocreateUsersDomains

Has two properties, enabled (boolean) and domains, which is a list of domains without the @ symbol.

Properties

Name Type Description Notes
domains [str] List of domains where the SAML automated user creation is enabled. [optional]
enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + OrganizationSettingsSamlAutocreateUsersDomains - Datadog API Client for Python

OrganizationSettingsSamlAutocreateUsersDomains

Has two properties, enabled (boolean) and domains, which is a list of domains without the @ symbol.

Properties

Name Type Description Notes
domains [str] List of domains where the SAML automated user creation is enabled. [optional]
enabled bool Whether or not the automated user creation based on SAML domain is enabled. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/OrganizationSettingsSamlIdpInitiatedLogin/index.html b/v1/OrganizationSettingsSamlIdpInitiatedLogin/index.html index 409cbb5f7d..437970f053 100644 --- a/v1/OrganizationSettingsSamlIdpInitiatedLogin/index.html +++ b/v1/OrganizationSettingsSamlIdpInitiatedLogin/index.html @@ -1 +1 @@ - OrganizationSettingsSamlIdpInitiatedLogin - Datadog API Client for Python
\ No newline at end of file + OrganizationSettingsSamlIdpInitiatedLogin - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationSettingsSamlStrictMode/index.html b/v1/OrganizationSettingsSamlStrictMode/index.html index 70342524e1..260da21886 100644 --- a/v1/OrganizationSettingsSamlStrictMode/index.html +++ b/v1/OrganizationSettingsSamlStrictMode/index.html @@ -1 +1 @@ - OrganizationSettingsSamlStrictMode - Datadog API Client for Python
\ No newline at end of file + OrganizationSettingsSamlStrictMode - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationSubscription/index.html b/v1/OrganizationSubscription/index.html index 9178ddcd56..329ee0fef0 100644 --- a/v1/OrganizationSubscription/index.html +++ b/v1/OrganizationSubscription/index.html @@ -1 +1 @@ - OrganizationSubscription - Datadog API Client for Python
\ No newline at end of file + OrganizationSubscription - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/OrganizationsApi/index.html b/v1/OrganizationsApi/index.html index aa9e6d4b3b..5b7acee261 100644 --- a/v1/OrganizationsApi/index.html +++ b/v1/OrganizationsApi/index.html @@ -201,4 +201,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling OrganizationsApi->upload_id_p_for_org: %s\n" % e) -

Parameters

Name Type Description Notes
public_id str The `public_id` of the organization you are operating with
idp_file file_type The path to the XML metadata file you wish to upload.

Return type

IdpResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
415 Unsupported Media Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
public_id str The `public_id` of the organization you are operating with
idp_file file_type The path to the XML metadata file you wish to upload.

Return type

IdpResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
415 Unsupported Media Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/PagerDutyIntegrationApi/index.html b/v1/PagerDutyIntegrationApi/index.html index d8934a4e95..680d9c4327 100644 --- a/v1/PagerDutyIntegrationApi/index.html +++ b/v1/PagerDutyIntegrationApi/index.html @@ -130,4 +130,4 @@ api_instance.update_pager_duty_integration_service(service_name, body) except ApiException as e: print("Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\n" % e) -

Parameters

Name Type Description Notes
service_name str The service name
body PagerDutyServiceKey Update an existing service object request body.

Return type

void (empty response body)

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
service_name str The service name
body PagerDutyServiceKey Update an existing service object request body.

Return type

void (empty response body)

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/PagerDutyService/index.html b/v1/PagerDutyService/index.html index 5db200d3f5..9545e7cc75 100644 --- a/v1/PagerDutyService/index.html +++ b/v1/PagerDutyService/index.html @@ -1 +1 @@ - PagerDutyService - Datadog API Client for Python

PagerDutyService

The PagerDuty service that is available for integration with Datadog.

Properties

Name Type Description Notes
service_key str Your service key in PagerDuty.
service_name str Your service name associated with a service key in PagerDuty.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + PagerDutyService - Datadog API Client for Python

PagerDutyService

The PagerDuty service that is available for integration with Datadog.

Properties

Name Type Description Notes
service_key str Your service key in PagerDuty.
service_name str Your service name associated with a service key in PagerDuty.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/PagerDutyServiceKey/index.html b/v1/PagerDutyServiceKey/index.html index cb0631649e..f3fb7a6ee8 100644 --- a/v1/PagerDutyServiceKey/index.html +++ b/v1/PagerDutyServiceKey/index.html @@ -1 +1 @@ - PagerDutyServiceKey - Datadog API Client for Python
\ No newline at end of file + PagerDutyServiceKey - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/PagerDutyServiceName/index.html b/v1/PagerDutyServiceName/index.html index 824fec3d53..25393f5f49 100644 --- a/v1/PagerDutyServiceName/index.html +++ b/v1/PagerDutyServiceName/index.html @@ -1 +1 @@ - PagerDutyServiceName - Datadog API Client for Python
\ No newline at end of file + PagerDutyServiceName - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/Point/index.html b/v1/Point/index.html index 89705fd1fc..c165aab7da 100644 --- a/v1/Point/index.html +++ b/v1/Point/index.html @@ -1 +1 @@ - Point - Datadog API Client for Python
\ No newline at end of file + Point - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ProcessQueryDefinition/index.html b/v1/ProcessQueryDefinition/index.html index 1eb2cbc27b..5297e89f20 100644 --- a/v1/ProcessQueryDefinition/index.html +++ b/v1/ProcessQueryDefinition/index.html @@ -1 +1 @@ - ProcessQueryDefinition - Datadog API Client for Python

ProcessQueryDefinition

The process query to use in the widget.

Properties

Name Type Description Notes
metric str Your chosen metric.
filter_by [str] List of processes. [optional]
limit int Max number of items in the filter list. [optional]
search_by str Your chosen search term. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ProcessQueryDefinition - Datadog API Client for Python

ProcessQueryDefinition

The process query to use in the widget.

Properties

Name Type Description Notes
metric str Your chosen metric.
filter_by [str] List of processes. [optional]
limit int Max number of items in the filter list. [optional]
search_by str Your chosen search term. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/QuerySortOrder/index.html b/v1/QuerySortOrder/index.html index 25f4c953cf..6be15155bd 100644 --- a/v1/QuerySortOrder/index.html +++ b/v1/QuerySortOrder/index.html @@ -1 +1 @@ - QuerySortOrder - Datadog API Client for Python
\ No newline at end of file + QuerySortOrder - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/QueryValueWidgetDefinition/index.html b/v1/QueryValueWidgetDefinition/index.html index 7c08717c48..eec6f6c4cb 100644 --- a/v1/QueryValueWidgetDefinition/index.html +++ b/v1/QueryValueWidgetDefinition/index.html @@ -1 +1 @@ - QueryValueWidgetDefinition - Datadog API Client for Python

QueryValueWidgetDefinition

Query values display the current value of a given metric, APM, or log query.

Properties

Name Type Description Notes
requests [QueryValueWidgetRequest] Widget definition.
type QueryValueWidgetDefinitionType
autoscale bool Whether to use auto-scaling or not. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
custom_unit str Display a unit of your choice on the widget. [optional]
precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional]
text_align WidgetTextAlign [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + QueryValueWidgetDefinition - Datadog API Client for Python

QueryValueWidgetDefinition

Query values display the current value of a given metric, APM, or log query.

Properties

Name Type Description Notes
requests [QueryValueWidgetRequest] Widget definition.
type QueryValueWidgetDefinitionType
autoscale bool Whether to use auto-scaling or not. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
custom_unit str Display a unit of your choice on the widget. [optional]
precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional]
text_align WidgetTextAlign [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/QueryValueWidgetDefinitionType/index.html b/v1/QueryValueWidgetDefinitionType/index.html index 8b728b7a15..32e438990c 100644 --- a/v1/QueryValueWidgetDefinitionType/index.html +++ b/v1/QueryValueWidgetDefinitionType/index.html @@ -1 +1 @@ - QueryValueWidgetDefinitionType - Datadog API Client for Python

QueryValueWidgetDefinitionType

Type of the query value widget.

Properties

Name Type Description Notes
value str Type of the query value widget. defaults to "query_value", must be one of ["query_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + QueryValueWidgetDefinitionType - Datadog API Client for Python

QueryValueWidgetDefinitionType

Type of the query value widget.

Properties

Name Type Description Notes
value str Type of the query value widget. defaults to "query_value", must be one of ["query_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/QueryValueWidgetRequest/index.html b/v1/QueryValueWidgetRequest/index.html index 15fd7abad0..e2323c4ff4 100644 --- a/v1/QueryValueWidgetRequest/index.html +++ b/v1/QueryValueWidgetRequest/index.html @@ -1 +1 @@ - QueryValueWidgetRequest - Datadog API Client for Python

QueryValueWidgetRequest

Updated query value widget.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
apm_query LogQueryDefinition [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str TODO. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 26, 2021
\ No newline at end of file + QueryValueWidgetRequest - Datadog API Client for Python

QueryValueWidgetRequest

Updated query value widget.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
apm_query LogQueryDefinition [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str TODO. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOBulkDelete/index.html b/v1/SLOBulkDelete/index.html index a255b7d5c0..1dd2c6d94a 100644 --- a/v1/SLOBulkDelete/index.html +++ b/v1/SLOBulkDelete/index.html @@ -1 +1 @@ - SLOBulkDelete - Datadog API Client for Python

SLOBulkDelete

A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID.

Properties

Name Type Description Notes
any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOBulkDelete - Datadog API Client for Python

SLOBulkDelete

A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID.

Properties

Name Type Description Notes
any string name [SLOTimeframe] any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOBulkDeleteError/index.html b/v1/SLOBulkDeleteError/index.html index 31d3c37d43..d04fc5bfa7 100644 --- a/v1/SLOBulkDeleteError/index.html +++ b/v1/SLOBulkDeleteError/index.html @@ -1 +1 @@ - SLOBulkDeleteError - Datadog API Client for Python
\ No newline at end of file + SLOBulkDeleteError - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOBulkDeleteResponse/index.html b/v1/SLOBulkDeleteResponse/index.html index 6ed93ab5f4..160f77672c 100644 --- a/v1/SLOBulkDeleteResponse/index.html +++ b/v1/SLOBulkDeleteResponse/index.html @@ -1 +1 @@ - SLOBulkDeleteResponse - Datadog API Client for Python

SLOBulkDeleteResponse

The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \"data\" and \"error\" fields in this response indicate which deletions succeeded and failed.

Properties

Name Type Description Notes
data SLOBulkDeleteResponseData [optional]
errors [SLOBulkDeleteError] Array of errors object returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + SLOBulkDeleteResponse - Datadog API Client for Python

SLOBulkDeleteResponse

The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \"data\" and \"error\" fields in this response indicate which deletions succeeded and failed.

Properties

Name Type Description Notes
data SLOBulkDeleteResponseData [optional]
errors [SLOBulkDeleteError] Array of errors object returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOBulkDeleteResponseData/index.html b/v1/SLOBulkDeleteResponseData/index.html index b56b9a6887..2678b92282 100644 --- a/v1/SLOBulkDeleteResponseData/index.html +++ b/v1/SLOBulkDeleteResponseData/index.html @@ -1 +1 @@ - SLOBulkDeleteResponseData - Datadog API Client for Python

SLOBulkDeleteResponseData

An array of service level objective objects.

Properties

Name Type Description Notes
deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional]
updated [str] An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one threshold was deleted, but that were not completely deleted). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOBulkDeleteResponseData - Datadog API Client for Python

SLOBulkDeleteResponseData

An array of service level objective objects.

Properties

Name Type Description Notes
deleted [str] An array of service level objective object IDs that indicates which objects that were completely deleted. [optional]
updated [str] An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one threshold was deleted, but that were not completely deleted). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOCorrection/index.html b/v1/SLOCorrection/index.html index 33b03e9d5c..25567d5b11 100644 --- a/v1/SLOCorrection/index.html +++ b/v1/SLOCorrection/index.html @@ -1 +1 @@ - SLOCorrection - Datadog API Client for Python
\ No newline at end of file + SLOCorrection - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionCategory/index.html b/v1/SLOCorrectionCategory/index.html index 2fb473fb86..eef123bd5f 100644 --- a/v1/SLOCorrectionCategory/index.html +++ b/v1/SLOCorrectionCategory/index.html @@ -1 +1 @@ - SLOCorrectionCategory - Datadog API Client for Python

SLOCorrectionCategory

Category the SLO correction belongs to

Properties

Name Type Description Notes
value str Category the SLO correction belongs to must be one of ["Scheduled Maintenance", "Outside Business Hours", "Deployment", "Other", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 13, 2021
\ No newline at end of file + SLOCorrectionCategory - Datadog API Client for Python

SLOCorrectionCategory

Category the SLO correction belongs to

Properties

Name Type Description Notes
value str Category the SLO correction belongs to must be one of ["Scheduled Maintenance", "Outside Business Hours", "Deployment", "Other", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOCorrectionCreateData/index.html b/v1/SLOCorrectionCreateData/index.html index 1a9afbb62d..83843fd6fd 100644 --- a/v1/SLOCorrectionCreateData/index.html +++ b/v1/SLOCorrectionCreateData/index.html @@ -1 +1 @@ - SLOCorrectionCreateData - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionCreateRequest/index.html b/v1/SLOCorrectionCreateRequest/index.html index a6bd7d602a..94caf8b6a5 100644 --- a/v1/SLOCorrectionCreateRequest/index.html +++ b/v1/SLOCorrectionCreateRequest/index.html @@ -1 +1 @@ - SLOCorrectionCreateRequest - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionCreateRequestAttributes/index.html b/v1/SLOCorrectionCreateRequestAttributes/index.html index b3e7a4e3e0..9be86683af 100644 --- a/v1/SLOCorrectionCreateRequestAttributes/index.html +++ b/v1/SLOCorrectionCreateRequestAttributes/index.html @@ -1 +1 @@ - SLOCorrectionCreateRequestAttributes - Datadog API Client for Python

SLOCorrectionCreateRequestAttributes

The attribute object associated with the SLO correction to be created

Properties

Name Type Description Notes
category SLOCorrectionCategory
end int Ending time of the correction in epoch seconds
slo_id str ID of the SLO that this correction will be applied to
start int Starting time of the correction in epoch seconds
description str Description of the correction being made. [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 22, 2021
\ No newline at end of file + SLOCorrectionCreateRequestAttributes - Datadog API Client for Python

SLOCorrectionCreateRequestAttributes

The attribute object associated with the SLO correction to be created

Properties

Name Type Description Notes
category SLOCorrectionCategory
end int Ending time of the correction in epoch seconds
slo_id str ID of the SLO that this correction will be applied to
start int Starting time of the correction in epoch seconds
description str Description of the correction being made. [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOCorrectionListResponse/index.html b/v1/SLOCorrectionListResponse/index.html index 31c6fb4bfd..6ca307e406 100644 --- a/v1/SLOCorrectionListResponse/index.html +++ b/v1/SLOCorrectionListResponse/index.html @@ -1 +1 @@ - SLOCorrectionListResponse - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionResponse/index.html b/v1/SLOCorrectionResponse/index.html index cd79706a4b..86e79477d6 100644 --- a/v1/SLOCorrectionResponse/index.html +++ b/v1/SLOCorrectionResponse/index.html @@ -1 +1 @@ - SLOCorrectionResponse - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionResponseAttributes/index.html b/v1/SLOCorrectionResponseAttributes/index.html index e7e6188a4c..a03713134a 100644 --- a/v1/SLOCorrectionResponseAttributes/index.html +++ b/v1/SLOCorrectionResponseAttributes/index.html @@ -1 +1 @@ - SLOCorrectionResponseAttributes - Datadog API Client for Python

SLOCorrectionResponseAttributes

The attribute object associated with the SLO correction

Properties

Name Type Description Notes
category SLOCorrectionCategory [optional]
creator Creator [optional]
description str Description of the correction being made. [optional]
end int Ending time of the correction in epoch seconds [optional]
slo_id str ID of the SLO that this correction will be applied to [optional]
start int Starting time of the correction in epoch seconds [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 22, 2021
\ No newline at end of file + SLOCorrectionResponseAttributes - Datadog API Client for Python

SLOCorrectionResponseAttributes

The attribute object associated with the SLO correction

Properties

Name Type Description Notes
category SLOCorrectionCategory [optional]
creator Creator [optional]
description str Description of the correction being made. [optional]
end int Ending time of the correction in epoch seconds [optional]
slo_id str ID of the SLO that this correction will be applied to [optional]
start int Starting time of the correction in epoch seconds [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOCorrectionType/index.html b/v1/SLOCorrectionType/index.html index 4cbb7bb178..51da1aa8ff 100644 --- a/v1/SLOCorrectionType/index.html +++ b/v1/SLOCorrectionType/index.html @@ -1 +1 @@ - SLOCorrectionType - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionUpdateData/index.html b/v1/SLOCorrectionUpdateData/index.html index b7703dd5fb..a98a8efb46 100644 --- a/v1/SLOCorrectionUpdateData/index.html +++ b/v1/SLOCorrectionUpdateData/index.html @@ -1 +1 @@ - SLOCorrectionUpdateData - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionUpdateRequest/index.html b/v1/SLOCorrectionUpdateRequest/index.html index 73db0e27e4..1916295f34 100644 --- a/v1/SLOCorrectionUpdateRequest/index.html +++ b/v1/SLOCorrectionUpdateRequest/index.html @@ -1 +1 @@ - SLOCorrectionUpdateRequest - Datadog API Client for Python
\ No newline at end of file + SLOCorrectionUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOCorrectionUpdateRequestAttributes/index.html b/v1/SLOCorrectionUpdateRequestAttributes/index.html index d8b7f30f68..33e0f82233 100644 --- a/v1/SLOCorrectionUpdateRequestAttributes/index.html +++ b/v1/SLOCorrectionUpdateRequestAttributes/index.html @@ -1 +1 @@ - SLOCorrectionUpdateRequestAttributes - Datadog API Client for Python

SLOCorrectionUpdateRequestAttributes

The attribute object associated with the SLO correction to be updated

Properties

Name Type Description Notes
category SLOCorrectionCategory [optional]
description str Description of the correction being made. [optional]
end int Ending time of the correction in epoch seconds [optional]
start int Starting time of the correction in epoch seconds [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 22, 2021
\ No newline at end of file + SLOCorrectionUpdateRequestAttributes - Datadog API Client for Python

SLOCorrectionUpdateRequestAttributes

The attribute object associated with the SLO correction to be updated

Properties

Name Type Description Notes
category SLOCorrectionCategory [optional]
description str Description of the correction being made. [optional]
end int Ending time of the correction in epoch seconds [optional]
start int Starting time of the correction in epoch seconds [optional]
timezone str The timezone to display in the UI for the correction times (defaults to \"UTC\") [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLODeleteResponse/index.html b/v1/SLODeleteResponse/index.html index f58d7c43ff..346716ab96 100644 --- a/v1/SLODeleteResponse/index.html +++ b/v1/SLODeleteResponse/index.html @@ -1 +1 @@ - SLODeleteResponse - Datadog API Client for Python

SLODeleteResponse

A response list of all service level objective deleted.

Properties

Name Type Description Notes
data [str] An array containing the ID of the deleted service level objective object. [optional]
errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLODeleteResponse - Datadog API Client for Python

SLODeleteResponse

A response list of all service level objective deleted.

Properties

Name Type Description Notes
data [str] An array containing the ID of the deleted service level objective object. [optional]
errors {str: (str,)} An dictionary containing the ID of the SLO as key and a deletion error as value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOErrorBudgetRemainingData/index.html b/v1/SLOErrorBudgetRemainingData/index.html index 8f4b755803..d75ab49af7 100644 --- a/v1/SLOErrorBudgetRemainingData/index.html +++ b/v1/SLOErrorBudgetRemainingData/index.html @@ -1 +1 @@ - SLOErrorBudgetRemainingData - Datadog API Client for Python

SLOErrorBudgetRemainingData

A mapping of threshold timeframe to the remaining error budget.

Properties

Name Type Description Notes
any string name float any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 12, 2021
\ No newline at end of file + SLOErrorBudgetRemainingData - Datadog API Client for Python

SLOErrorBudgetRemainingData

A mapping of threshold timeframe to the remaining error budget.

Properties

Name Type Description Notes
any string name float any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOErrorTimeframe/index.html b/v1/SLOErrorTimeframe/index.html index cf7fb14062..598ad36051 100644 --- a/v1/SLOErrorTimeframe/index.html +++ b/v1/SLOErrorTimeframe/index.html @@ -1 +1 @@ - SLOErrorTimeframe - Datadog API Client for Python

SLOErrorTimeframe

The timeframe of the threshold associated with this error or \"all\" if all thresholds are affected.

Properties

Name Type Description Notes
value str The timeframe of the threshold associated with this error or \"all\" if all thresholds are affected. must be one of ["7d", "30d", "90d", "all", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOErrorTimeframe - Datadog API Client for Python

SLOErrorTimeframe

The timeframe of the threshold associated with this error or \"all\" if all thresholds are affected.

Properties

Name Type Description Notes
value str The timeframe of the threshold associated with this error or \"all\" if all thresholds are affected. must be one of ["7d", "30d", "90d", "all", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryMetrics/index.html b/v1/SLOHistoryMetrics/index.html index f576d2d511..c6009e6632 100644 --- a/v1/SLOHistoryMetrics/index.html +++ b/v1/SLOHistoryMetrics/index.html @@ -1 +1 @@ - SLOHistoryMetrics - Datadog API Client for Python

SLOHistoryMetrics

A metric based SLO history response. This is not included in responses for monitor based SLOs.

Properties

Name Type Description Notes
denominator SLOHistoryMetricsSeries
interval int The aggregated query interval for the series data. It's implicit based on the query time window.
numerator SLOHistoryMetricsSeries
query str The combined numerator and denominator query CSV.
res_type str The series result type. This mimics `batch_query` response type.
resp_version int The series response version type. This mimics `batch_query` response type.
times [float] An array of query timestamps in EPOCH milliseconds
message str Optional message if there are specific query issues/warnings. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 12, 2021
\ No newline at end of file + SLOHistoryMetrics - Datadog API Client for Python

SLOHistoryMetrics

A metric based SLO history response. This is not included in responses for monitor based SLOs.

Properties

Name Type Description Notes
denominator SLOHistoryMetricsSeries
interval int The aggregated query interval for the series data. It's implicit based on the query time window.
numerator SLOHistoryMetricsSeries
query str The combined numerator and denominator query CSV.
res_type str The series result type. This mimics `batch_query` response type.
resp_version int The series response version type. This mimics `batch_query` response type.
times [float] An array of query timestamps in EPOCH milliseconds
message str Optional message if there are specific query issues/warnings. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryMetricsSeries/index.html b/v1/SLOHistoryMetricsSeries/index.html index cc299a607c..537c1555db 100644 --- a/v1/SLOHistoryMetricsSeries/index.html +++ b/v1/SLOHistoryMetricsSeries/index.html @@ -1 +1 @@ - SLOHistoryMetricsSeries - Datadog API Client for Python

SLOHistoryMetricsSeries

A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint.

Properties

Name Type Description Notes
count int Count of submitted metrics.
metadata SLOHistoryMetricsSeriesMetadata
sum float Total sum of the query.
values [float] The query values for each metric.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOHistoryMetricsSeries - Datadog API Client for Python

SLOHistoryMetricsSeries

A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint.

Properties

Name Type Description Notes
count int Count of submitted metrics.
metadata SLOHistoryMetricsSeriesMetadata
sum float Total sum of the query.
values [float] The query values for each metric.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryMetricsSeriesMetadata/index.html b/v1/SLOHistoryMetricsSeriesMetadata/index.html index 48f59dc7d8..0341007ce1 100644 --- a/v1/SLOHistoryMetricsSeriesMetadata/index.html +++ b/v1/SLOHistoryMetricsSeriesMetadata/index.html @@ -1 +1 @@ - SLOHistoryMetricsSeriesMetadata - Datadog API Client for Python

SLOHistoryMetricsSeriesMetadata

Query metadata.

Properties

Name Type Description Notes
aggr str Query aggregator function. [optional]
expression str Query expression. [optional]
metric str Query metric used. [optional]
query_index int Query index from original combined query. [optional]
scope str Query scope. [optional]
unit [SLOHistoryMetricsSeriesMetadataUnit], none_type An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 3, 2021
\ No newline at end of file + SLOHistoryMetricsSeriesMetadata - Datadog API Client for Python

SLOHistoryMetricsSeriesMetadata

Query metadata.

Properties

Name Type Description Notes
aggr str Query aggregator function. [optional]
expression str Query expression. [optional]
metric str Query metric used. [optional]
query_index int Query index from original combined query. [optional]
scope str Query scope. [optional]
unit [SLOHistoryMetricsSeriesMetadataUnit], none_type An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryMetricsSeriesMetadataUnit/index.html b/v1/SLOHistoryMetricsSeriesMetadataUnit/index.html index 250c85dd3b..e17750ac20 100644 --- a/v1/SLOHistoryMetricsSeriesMetadataUnit/index.html +++ b/v1/SLOHistoryMetricsSeriesMetadataUnit/index.html @@ -1 +1 @@ - SLOHistoryMetricsSeriesMetadataUnit - Datadog API Client for Python

SLOHistoryMetricsSeriesMetadataUnit

An Object of metric units.

Properties

Name Type Description Notes
family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional]
id int The ID of the metric unit. [optional]
name str The unit of the metric, for instance `byte`. [optional]
plural str, none_type The plural Unit of metric, for instance `bytes`. [optional]
scale_factor float The scale factor of metric unit, for instance `1.0`. [optional]
short_name str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 3, 2021
\ No newline at end of file + SLOHistoryMetricsSeriesMetadataUnit - Datadog API Client for Python

SLOHistoryMetricsSeriesMetadataUnit

An Object of metric units.

Properties

Name Type Description Notes
family str The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. [optional]
id int The ID of the metric unit. [optional]
name str The unit of the metric, for instance `byte`. [optional]
plural str, none_type The plural Unit of metric, for instance `bytes`. [optional]
scale_factor float The scale factor of metric unit, for instance `1.0`. [optional]
short_name str, none_type A shorter and abbreviated version of the metric unit, for instance `B`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryResponse/index.html b/v1/SLOHistoryResponse/index.html index 35023f1b89..037700b4f4 100644 --- a/v1/SLOHistoryResponse/index.html +++ b/v1/SLOHistoryResponse/index.html @@ -1 +1 @@ - SLOHistoryResponse - Datadog API Client for Python
\ No newline at end of file + SLOHistoryResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOHistoryResponseData/index.html b/v1/SLOHistoryResponseData/index.html index 10da88e5db..f8dbaabf95 100644 --- a/v1/SLOHistoryResponseData/index.html +++ b/v1/SLOHistoryResponseData/index.html @@ -1 +1 @@ - SLOHistoryResponseData - Datadog API Client for Python

SLOHistoryResponseData

An array of service level objective objects.

Properties

Name Type Description Notes
from_ts int The `from` timestamp in epoch seconds. [optional]
group_by [str] For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for `monitor` based SLOs. [optional]
groups [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional]
monitors [SLOHistorySLIData] For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for `metric` based SLOs. [optional]
overall SLOHistorySLIData [optional]
series SLOHistoryMetrics [optional]
thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional]
to_ts int The `to` timestamp in epoch seconds. [optional]
type SLOType [optional]
type_id SLOTypeNumeric [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 12, 2021
\ No newline at end of file + SLOHistoryResponseData - Datadog API Client for Python

SLOHistoryResponseData

An array of service level objective objects.

Properties

Name Type Description Notes
from_ts int The `from` timestamp in epoch seconds. [optional]
group_by [str] For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for `monitor` based SLOs. [optional]
groups [SLOHistorySLIData] For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. [optional]
monitors [SLOHistorySLIData] For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for `metric` based SLOs. [optional]
overall SLOHistorySLIData [optional]
series SLOHistoryMetrics [optional]
thresholds {str: (SLOThreshold,)} mapping of string timeframe to the SLO threshold. [optional]
to_ts int The `to` timestamp in epoch seconds. [optional]
type SLOType [optional]
type_id SLOTypeNumeric [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOHistoryResponseError/index.html b/v1/SLOHistoryResponseError/index.html index 7e021422e0..523a8cfca0 100644 --- a/v1/SLOHistoryResponseError/index.html +++ b/v1/SLOHistoryResponseError/index.html @@ -1 +1 @@ - SLOHistoryResponseError - Datadog API Client for Python
\ No newline at end of file + SLOHistoryResponseError - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOHistorySLIData/index.html b/v1/SLOHistorySLIData/index.html index d7ced0463c..cbaf21220e 100644 --- a/v1/SLOHistorySLIData/index.html +++ b/v1/SLOHistorySLIData/index.html @@ -1 +1 @@ - SLOHistorySLIData - Datadog API Client for Python

SLOHistorySLIData

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

Properties

Name Type Description Notes
error_budget_remaining SLOErrorBudgetRemainingData [optional]
errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional]
group str For groups in a grouped SLO, this is the group name. [optional]
history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional]
monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional]
monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional]
name str For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. [optional]
precision {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional]
preview bool For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. [optional]
sli_value float The current SLI value of the SLO over the history window. [optional]
span_precision float The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. [optional]
uptime float Use `sli_value` instead. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 12, 2021
\ No newline at end of file + SLOHistorySLIData - Datadog API Client for Python

SLOHistorySLIData

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

Properties

Name Type Description Notes
error_budget_remaining SLOErrorBudgetRemainingData [optional]
errors [SLOHistoryResponseError] A list of errors while querying the history data for the service level objective. [optional]
group str For groups in a grouped SLO, this is the group name. [optional]
history [[float]] For `monitor` based SLOs, this includes the aggregated history uptime time series. [optional]
monitor_modified int For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. [optional]
monitor_type str For `monitor` based SLOs, this describes the type of monitor. [optional]
name str For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. [optional]
precision {str: (float,)} A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. [optional]
preview bool For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. [optional]
sli_value float The current SLI value of the SLO over the history window. [optional]
span_precision float The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. [optional]
uptime float Use `sli_value` instead. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOListResponse/index.html b/v1/SLOListResponse/index.html index bcbf305391..387221bab3 100644 --- a/v1/SLOListResponse/index.html +++ b/v1/SLOListResponse/index.html @@ -1 +1 @@ - SLOListResponse - Datadog API Client for Python

SLOListResponse

A response with one or more service level objective.

Properties

Name Type Description Notes
data [ServiceLevelObjective] An array of service level objective objects. [optional]
errors [str] An array of error messages. Each endpoint documents how/whether this field is used. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOResponse/index.html b/v1/SLOResponse/index.html index 366192d1ac..89cf3e985c 100644 --- a/v1/SLOResponse/index.html +++ b/v1/SLOResponse/index.html @@ -1 +1 @@ - SLOResponse - Datadog API Client for Python
\ No newline at end of file + SLOResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOThreshold/index.html b/v1/SLOThreshold/index.html index 45d2e7969f..a8f0a903c2 100644 --- a/v1/SLOThreshold/index.html +++ b/v1/SLOThreshold/index.html @@ -1 +1 @@ - SLOThreshold - Datadog API Client for Python

SLOThreshold

SLO thresholds (target and optionally warning) for a single time window.

Properties

Name Type Description Notes
target float The target value for the service level indicator within the corresponding timeframe.
timeframe SLOTimeframe
target_display str A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (e.g. `98.00`). Always included in service level objective responses. Ignored in create/update requests. [optional]
warning float The warning value for the service level objective. [optional]
warning_display str A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOThreshold - Datadog API Client for Python

SLOThreshold

SLO thresholds (target and optionally warning) for a single time window.

Properties

Name Type Description Notes
target float The target value for the service level indicator within the corresponding timeframe.
timeframe SLOTimeframe
target_display str A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (e.g. `98.00`). Always included in service level objective responses. Ignored in create/update requests. [optional]
warning float The warning value for the service level objective. [optional]
warning_display str A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOTimeframe/index.html b/v1/SLOTimeframe/index.html index 64b0fa1126..0ee6a9dff8 100644 --- a/v1/SLOTimeframe/index.html +++ b/v1/SLOTimeframe/index.html @@ -1 +1 @@ - SLOTimeframe - Datadog API Client for Python
\ No newline at end of file + SLOTimeframe - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOType/index.html b/v1/SLOType/index.html index 3b0dbbca26..6c88d16ae2 100644 --- a/v1/SLOType/index.html +++ b/v1/SLOType/index.html @@ -1 +1 @@ - SLOType - Datadog API Client for Python
\ No newline at end of file + SLOType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SLOTypeNumeric/index.html b/v1/SLOTypeNumeric/index.html index 2b75857c7e..f2fb29172b 100644 --- a/v1/SLOTypeNumeric/index.html +++ b/v1/SLOTypeNumeric/index.html @@ -1 +1 @@ - SLOTypeNumeric - Datadog API Client for Python

SLOTypeNumeric

A numeric representation of the type of the service level objective (0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests.

Properties

Name Type Description Notes
value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOTypeNumeric - Datadog API Client for Python

SLOTypeNumeric

A numeric representation of the type of the service level objective (0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests.

Properties

Name Type Description Notes
value int A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. must be one of [0, 1, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOWidgetDefinition/index.html b/v1/SLOWidgetDefinition/index.html index c7e7937449..75363f0185 100644 --- a/v1/SLOWidgetDefinition/index.html +++ b/v1/SLOWidgetDefinition/index.html @@ -1 +1 @@ - SLOWidgetDefinition - Datadog API Client for Python

SLOWidgetDefinition

Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.

Properties

Name Type Description Notes
type SLOWidgetDefinitionType
view_type str Type of view displayed by the widget. defaults to "detail"
show_error_budget bool Defined error budget. [optional]
slo_id str ID of the SLO displayed. [optional]
time_windows [WidgetTimeWindows] Times being monitored. [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
view_mode WidgetViewMode [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SLOWidgetDefinition - Datadog API Client for Python

SLOWidgetDefinition

Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.

Properties

Name Type Description Notes
type SLOWidgetDefinitionType
view_type str Type of view displayed by the widget. defaults to "detail"
show_error_budget bool Defined error budget. [optional]
slo_id str ID of the SLO displayed. [optional]
time_windows [WidgetTimeWindows] Times being monitored. [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
view_mode WidgetViewMode [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SLOWidgetDefinitionType/index.html b/v1/SLOWidgetDefinitionType/index.html index f71e42df9e..56d1296bf3 100644 --- a/v1/SLOWidgetDefinitionType/index.html +++ b/v1/SLOWidgetDefinitionType/index.html @@ -1 +1 @@ - SLOWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file + SLOWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ScatterPlotRequest/index.html b/v1/ScatterPlotRequest/index.html index eaad9b8067..5e6ee52e5e 100644 --- a/v1/ScatterPlotRequest/index.html +++ b/v1/ScatterPlotRequest/index.html @@ -1 +1 @@ - ScatterPlotRequest - Datadog API Client for Python

ScatterPlotRequest

Updated scatter plot.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + ScatterPlotRequest - Datadog API Client for Python

ScatterPlotRequest

Updated scatter plot.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
apm_query LogQueryDefinition [optional]
event_query LogQueryDefinition [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ScatterPlotWidgetDefinition/index.html b/v1/ScatterPlotWidgetDefinition/index.html index dd339ba3a4..e96e1e3979 100644 --- a/v1/ScatterPlotWidgetDefinition/index.html +++ b/v1/ScatterPlotWidgetDefinition/index.html @@ -1 +1 @@ - ScatterPlotWidgetDefinition - Datadog API Client for Python

ScatterPlotWidgetDefinition

The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.

Properties

Name Type Description Notes
requests ScatterPlotWidgetDefinitionRequests
type ScatterPlotWidgetDefinitionType
color_by_groups [str] List of groups used for colors. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
xaxis WidgetAxis [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ScatterPlotWidgetDefinition - Datadog API Client for Python

ScatterPlotWidgetDefinition

The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.

Properties

Name Type Description Notes
requests ScatterPlotWidgetDefinitionRequests
type ScatterPlotWidgetDefinitionType
color_by_groups [str] List of groups used for colors. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
xaxis WidgetAxis [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ScatterPlotWidgetDefinitionRequests/index.html b/v1/ScatterPlotWidgetDefinitionRequests/index.html index 6424e6df26..ff5a6c6ee1 100644 --- a/v1/ScatterPlotWidgetDefinitionRequests/index.html +++ b/v1/ScatterPlotWidgetDefinitionRequests/index.html @@ -1 +1 @@ - ScatterPlotWidgetDefinitionRequests - Datadog API Client for Python
\ No newline at end of file + ScatterPlotWidgetDefinitionRequests - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ScatterPlotWidgetDefinitionType/index.html b/v1/ScatterPlotWidgetDefinitionType/index.html index 4836e80dbd..5c33295cca 100644 --- a/v1/ScatterPlotWidgetDefinitionType/index.html +++ b/v1/ScatterPlotWidgetDefinitionType/index.html @@ -1 +1 @@ - ScatterPlotWidgetDefinitionType - Datadog API Client for Python

ScatterPlotWidgetDefinitionType

Type of the scatter plot widget.

Properties

Name Type Description Notes
value str Type of the scatter plot widget. defaults to "scatterplot", must be one of ["scatterplot", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + ScatterPlotWidgetDefinitionType - Datadog API Client for Python

ScatterPlotWidgetDefinitionType

Type of the scatter plot widget.

Properties

Name Type Description Notes
value str Type of the scatter plot widget. defaults to "scatterplot", must be one of ["scatterplot", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceLevelObjective/index.html b/v1/ServiceLevelObjective/index.html index 79e220c32b..a9f0a218d7 100644 --- a/v1/ServiceLevelObjective/index.html +++ b/v1/ServiceLevelObjective/index.html @@ -1 +1 @@ - ServiceLevelObjective - Datadog API Client for Python

ServiceLevelObjective

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

Properties

Name Type Description Notes
name str The name of the service level objective object.
thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object.
type SLOType
created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
creator Creator [optional]
description str, none_type A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. [optional]
groups [str] A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. [optional]
id str A unique identifier for the service level objective object. Always included in service level objective responses. [optional][readonly]
modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor`. [optional]
monitor_tags [str] The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). [optional]
query ServiceLevelObjectiveQuery [optional]
tags [str] A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ServiceLevelObjective - Datadog API Client for Python

ServiceLevelObjective

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

Properties

Name Type Description Notes
name str The name of the service level objective object.
thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object.
type SLOType
created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
creator Creator [optional]
description str, none_type A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. [optional]
groups [str] A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. [optional]
id str A unique identifier for the service level objective object. Always included in service level objective responses. [optional][readonly]
modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor`. [optional]
monitor_tags [str] The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). [optional]
query ServiceLevelObjectiveQuery [optional]
tags [str] A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceLevelObjectiveCorrectionsApi/index.html b/v1/ServiceLevelObjectiveCorrectionsApi/index.html index 913944df11..543e443ef6 100644 --- a/v1/ServiceLevelObjectiveCorrectionsApi/index.html +++ b/v1/ServiceLevelObjectiveCorrectionsApi/index.html @@ -185,4 +185,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\n" % e) -

Parameters

Name Type Description Notes
slo_correction_id str The ID of the SLO correction object
body SLOCorrectionUpdateRequest The edited SLO correction object.

Return type

SLOCorrectionResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
slo_correction_id str The ID of the SLO correction object
body SLOCorrectionUpdateRequest The edited SLO correction object.

Return type

SLOCorrectionResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceLevelObjectiveQuery/index.html b/v1/ServiceLevelObjectiveQuery/index.html index 77c162e676..ec468fb627 100644 --- a/v1/ServiceLevelObjectiveQuery/index.html +++ b/v1/ServiceLevelObjectiveQuery/index.html @@ -1 +1 @@ - ServiceLevelObjectiveQuery - Datadog API Client for Python

ServiceLevelObjectiveQuery

A metric SLI query. Required if type is metric. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.

Properties

Name Type Description Notes
denominator str A Datadog metric query for total (valid) events.
numerator str A Datadog metric query for good events.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ServiceLevelObjectiveQuery - Datadog API Client for Python

ServiceLevelObjectiveQuery

A metric SLI query. Required if type is metric. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.

Properties

Name Type Description Notes
denominator str A Datadog metric query for total (valid) events.
numerator str A Datadog metric query for good events.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceLevelObjectiveRequest/index.html b/v1/ServiceLevelObjectiveRequest/index.html index 942a0cb450..be89baab1d 100644 --- a/v1/ServiceLevelObjectiveRequest/index.html +++ b/v1/ServiceLevelObjectiveRequest/index.html @@ -1 +1 @@ - ServiceLevelObjectiveRequest - Datadog API Client for Python

ServiceLevelObjectiveRequest

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

Properties

Name Type Description Notes
name str The name of the service level objective object.
thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object.
type SLOType
created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
creator Creator [optional]
description str, none_type A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. [optional]
groups [str] A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. [optional]
id str A unique identifier for the service level objective object. Always included in service level objective responses. [optional][readonly]
modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor`. [optional]
query ServiceLevelObjectiveQuery [optional]
tags [str] A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ServiceLevelObjectiveRequest - Datadog API Client for Python

ServiceLevelObjectiveRequest

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

Properties

Name Type Description Notes
name str The name of the service level objective object.
thresholds [SLOThreshold] The thresholds (timeframes and associated targets) for this service level objective object.
type SLOType
created_at int Creation timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
creator Creator [optional]
description str, none_type A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. [optional]
groups [str] A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. [optional]
id str A unique identifier for the service level objective object. Always included in service level objective responses. [optional][readonly]
modified_at int Modification timestamp (UNIX time in seconds) Always included in service level objective responses. [optional][readonly]
monitor_ids [int] A list of monitor ids that defines the scope of a monitor service level objective. Required if type is `monitor`. [optional]
query ServiceLevelObjectiveQuery [optional]
tags [str] A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceLevelObjectivesApi/index.html b/v1/ServiceLevelObjectivesApi/index.html index 8f0ea78b8a..55acffcf1a 100644 --- a/v1/ServiceLevelObjectivesApi/index.html +++ b/v1/ServiceLevelObjectivesApi/index.html @@ -323,4 +323,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling ServiceLevelObjectivesApi->update_slo: %s\n" % e) -

Parameters

Name Type Description Notes
slo_id str The ID of the service level objective object.
body ServiceLevelObjective The edited service level objective request object.

Return type

SLOListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
slo_id str The ID of the service level objective object.
body ServiceLevelObjective The edited service level objective request object.

Return type

SLOListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceMapWidgetDefinition/index.html b/v1/ServiceMapWidgetDefinition/index.html index 21822b5efa..68dbd3b252 100644 --- a/v1/ServiceMapWidgetDefinition/index.html +++ b/v1/ServiceMapWidgetDefinition/index.html @@ -1 +1 @@ - ServiceMapWidgetDefinition - Datadog API Client for Python

ServiceMapWidgetDefinition

This widget displays a map of a service to all of the services that call it, and all of the services that it calls.

Properties

Name Type Description Notes
filters [str] Your environment and primary tag (or * if enabled for your account).
service str The ID of the service you want to map.
type ServiceMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
title str The title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ServiceMapWidgetDefinition - Datadog API Client for Python

ServiceMapWidgetDefinition

This widget displays a map of a service to all of the services that call it, and all of the services that it calls.

Properties

Name Type Description Notes
filters [str] Your environment and primary tag (or * if enabled for your account).
service str The ID of the service you want to map.
type ServiceMapWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
title str The title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceMapWidgetDefinitionType/index.html b/v1/ServiceMapWidgetDefinitionType/index.html index d2922182fc..10d91c3fdf 100644 --- a/v1/ServiceMapWidgetDefinitionType/index.html +++ b/v1/ServiceMapWidgetDefinitionType/index.html @@ -1 +1 @@ - ServiceMapWidgetDefinitionType - Datadog API Client for Python

ServiceMapWidgetDefinitionType

Type of the service map widget.

Properties

Name Type Description Notes
value str Type of the service map widget. defaults to "servicemap", must be one of ["servicemap", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + ServiceMapWidgetDefinitionType - Datadog API Client for Python

ServiceMapWidgetDefinitionType

Type of the service map widget.

Properties

Name Type Description Notes
value str Type of the service map widget. defaults to "servicemap", must be one of ["servicemap", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceSummaryWidgetDefinition/index.html b/v1/ServiceSummaryWidgetDefinition/index.html index 8d1d7cbc04..a67039297b 100644 --- a/v1/ServiceSummaryWidgetDefinition/index.html +++ b/v1/ServiceSummaryWidgetDefinition/index.html @@ -1 +1 @@ - ServiceSummaryWidgetDefinition - Datadog API Client for Python

ServiceSummaryWidgetDefinition

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
env str APM environment.
service str APM service.
span_name str APM span name.
type ServiceSummaryWidgetDefinitionType
display_format WidgetServiceSummaryDisplayFormat [optional]
show_breakdown bool Whether to show the latency breakdown or not. [optional]
show_distribution bool Whether to show the latency distribution or not. [optional]
show_errors bool Whether to show the error metrics or not. [optional]
show_hits bool Whether to show the hits metrics or not. [optional]
show_latency bool Whether to show the latency metrics or not. [optional]
show_resource_list bool Whether to show the resource list or not. [optional]
size_format WidgetSizeFormat [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ServiceSummaryWidgetDefinition - Datadog API Client for Python

ServiceSummaryWidgetDefinition

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

Properties

Name Type Description Notes
env str APM environment.
service str APM service.
span_name str APM span name.
type ServiceSummaryWidgetDefinitionType
display_format WidgetServiceSummaryDisplayFormat [optional]
show_breakdown bool Whether to show the latency breakdown or not. [optional]
show_distribution bool Whether to show the latency distribution or not. [optional]
show_errors bool Whether to show the error metrics or not. [optional]
show_hits bool Whether to show the hits metrics or not. [optional]
show_latency bool Whether to show the latency metrics or not. [optional]
show_resource_list bool Whether to show the resource list or not. [optional]
size_format WidgetSizeFormat [optional]
time WidgetTime [optional]
title str Title of the widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ServiceSummaryWidgetDefinitionType/index.html b/v1/ServiceSummaryWidgetDefinitionType/index.html index 8fab6388c7..6d9e60ecad 100644 --- a/v1/ServiceSummaryWidgetDefinitionType/index.html +++ b/v1/ServiceSummaryWidgetDefinitionType/index.html @@ -1 +1 @@ - ServiceSummaryWidgetDefinitionType - Datadog API Client for Python

ServiceSummaryWidgetDefinitionType

Type of the service summary widget.

Properties

Name Type Description Notes
value str Type of the service summary widget. defaults to "trace_service", must be one of ["trace_service", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + ServiceSummaryWidgetDefinitionType - Datadog API Client for Python

ServiceSummaryWidgetDefinitionType

Type of the service summary widget.

Properties

Name Type Description Notes
value str Type of the service summary widget. defaults to "trace_service", must be one of ["trace_service", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SlackIntegrationApi/index.html b/v1/SlackIntegrationApi/index.html index f8a47f9e20..70109a879f 100644 --- a/v1/SlackIntegrationApi/index.html +++ b/v1/SlackIntegrationApi/index.html @@ -178,4 +178,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\n" % e) -

Parameters

Name Type Description Notes
account_name str Your Slack account name.
channel_name str The name of the Slack channel being operated on.
body SlackIntegrationChannel Payload describing fields and values to be updated.

Return type

SlackIntegrationChannel

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
account_name str Your Slack account name.
channel_name str The name of the Slack channel being operated on.
body SlackIntegrationChannel Payload describing fields and values to be updated.

Return type

SlackIntegrationChannel

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Item Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SlackIntegrationChannel/index.html b/v1/SlackIntegrationChannel/index.html index 4e49d6586b..87fd3151fa 100644 --- a/v1/SlackIntegrationChannel/index.html +++ b/v1/SlackIntegrationChannel/index.html @@ -1 +1 @@ - SlackIntegrationChannel - Datadog API Client for Python
\ No newline at end of file + SlackIntegrationChannel - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SlackIntegrationChannelDisplay/index.html b/v1/SlackIntegrationChannelDisplay/index.html index 77aa34d026..5bc5919bd0 100644 --- a/v1/SlackIntegrationChannelDisplay/index.html +++ b/v1/SlackIntegrationChannelDisplay/index.html @@ -1 +1 @@ - SlackIntegrationChannelDisplay - Datadog API Client for Python

SlackIntegrationChannelDisplay

Configuration options for what is shown in an alert event message.

Properties

Name Type Description Notes
message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True
notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True
snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True
tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True

[Back to Model list] [Back to API list] [Back to README]

Last update: February 23, 2021
\ No newline at end of file + SlackIntegrationChannelDisplay - Datadog API Client for Python

SlackIntegrationChannelDisplay

Configuration options for what is shown in an alert event message.

Properties

Name Type Description Notes
message bool Show the main body of the alert event. [optional] if omitted the server will use the default value of True
notified bool Show the list of @-handles in the alert event. [optional] if omitted the server will use the default value of True
snapshot bool Show the alert event's snapshot image. [optional] if omitted the server will use the default value of True
tags bool Show the scopes on which the monitor alerted. [optional] if omitted the server will use the default value of True

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SlackIntegrationChannels/index.html b/v1/SlackIntegrationChannels/index.html index 9e591f44b2..0db8d210f0 100644 --- a/v1/SlackIntegrationChannels/index.html +++ b/v1/SlackIntegrationChannels/index.html @@ -1 +1 @@ - SlackIntegrationChannels - Datadog API Client for Python
\ No newline at end of file + SlackIntegrationChannels - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SnapshotsApi/index.html b/v1/SnapshotsApi/index.html index 9bf47b8d57..fee04046c4 100644 --- a/v1/SnapshotsApi/index.html +++ b/v1/SnapshotsApi/index.html @@ -44,4 +44,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling SnapshotsApi->get_graph_snapshot: %s\n" % e) -

Parameters

Name Type Description Notes
start int The POSIX timestamp of the start of the query.
end int The POSIX timestamp of the end of the query.
metric_query str The metric query. [optional]
event_query str A query that adds event bands to the graph. [optional]
graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional]
title str A title for the graph. If no title is specified, the graph does not have a title. [optional]

Return type

GraphSnapshot

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
start int The POSIX timestamp of the start of the query.
end int The POSIX timestamp of the end of the query.
metric_query str The metric query. [optional]
event_query str A query that adds event bands to the graph. [optional]
graph_def str A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded. [optional]
title str A title for the graph. If no title is specified, the graph does not have a title. [optional]

Return type

GraphSnapshot

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPIStep/index.html b/v1/SyntheticsAPIStep/index.html index 2fe6480fd2..89905a3c36 100644 --- a/v1/SyntheticsAPIStep/index.html +++ b/v1/SyntheticsAPIStep/index.html @@ -1 +1 @@ - SyntheticsAPIStep - Datadog API Client for Python

SyntheticsAPIStep

The steps used in a Synthetics multistep API test.

Properties

Name Type Description Notes
assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of []
extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional]
name str The name of the step. [optional]
request SyntheticsTestRequest [optional]
subtype SyntheticsAPIStepSubtype [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + SyntheticsAPIStep - Datadog API Client for Python

SyntheticsAPIStep

The steps used in a Synthetics multistep API test.

Properties

Name Type Description Notes
assertions [SyntheticsAssertion] Array of assertions used for the test. [optional] if omitted the server will use the default value of []
extracted_values [SyntheticsParsingOptions] Array of values to parse and save as variables from the response. [optional]
name str The name of the step. [optional]
request SyntheticsTestRequest [optional]
subtype SyntheticsAPIStepSubtype [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPIStepSubtype/index.html b/v1/SyntheticsAPIStepSubtype/index.html index b6f6aa5b05..7ea253269a 100644 --- a/v1/SyntheticsAPIStepSubtype/index.html +++ b/v1/SyntheticsAPIStepSubtype/index.html @@ -1 +1 @@ - SyntheticsAPIStepSubtype - Datadog API Client for Python

SyntheticsAPIStepSubtype

The subtype of the Synthetic multistep API test step, currently only supporting http.

Properties

Name Type Description Notes
value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to "http", must be one of ["http", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + SyntheticsAPIStepSubtype - Datadog API Client for Python

SyntheticsAPIStepSubtype

The subtype of the Synthetic multistep API test step, currently only supporting http.

Properties

Name Type Description Notes
value str The subtype of the Synthetic multistep API test step, currently only supporting `http`. defaults to "http", must be one of ["http", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPITest/index.html b/v1/SyntheticsAPITest/index.html index f83cc92087..846ff13cee 100644 --- a/v1/SyntheticsAPITest/index.html +++ b/v1/SyntheticsAPITest/index.html @@ -1 +1 @@ - SyntheticsAPITest - Datadog API Client for Python

SyntheticsAPITest

Object containing details about a Synthetic API test.

Properties

Name Type Description Notes
config SyntheticsAPITestConfig [optional]
locations [str] Array of locations used to run the test. [optional]
message str Notification message associated with the test. [optional]
monitor_id int The associated monitor ID. [optional]
name str Name of the test. [optional]
options SyntheticsTestOptions [optional]
public_id str The public ID for the test. [optional]
status SyntheticsTestPauseStatus [optional]
subtype SyntheticsTestDetailsSubType [optional]
tags [str] Array of tags attached to the test. [optional]
type SyntheticsAPITestType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 2, 2021
\ No newline at end of file + SyntheticsAPITest - Datadog API Client for Python

SyntheticsAPITest

Object containing details about a Synthetic API test.

Properties

Name Type Description Notes
config SyntheticsAPITestConfig [optional]
locations [str] Array of locations used to run the test. [optional]
message str Notification message associated with the test. [optional]
monitor_id int The associated monitor ID. [optional]
name str Name of the test. [optional]
options SyntheticsTestOptions [optional]
public_id str The public ID for the test. [optional]
status SyntheticsTestPauseStatus [optional]
subtype SyntheticsTestDetailsSubType [optional]
tags [str] Array of tags attached to the test. [optional]
type SyntheticsAPITestType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPITestConfig/index.html b/v1/SyntheticsAPITestConfig/index.html index 152e14cf7c..6f4e20a0c7 100644 --- a/v1/SyntheticsAPITestConfig/index.html +++ b/v1/SyntheticsAPITestConfig/index.html @@ -1 +1 @@ - SyntheticsAPITestConfig - Datadog API Client for Python

SyntheticsAPITestConfig

Configuration object for a Synthetic API test.

Properties

Name Type Description Notes
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional]
request SyntheticsTestRequest [optional]
steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + SyntheticsAPITestConfig - Datadog API Client for Python

SyntheticsAPITestConfig

Configuration object for a Synthetic API test.

Properties

Name Type Description Notes
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] Array of variables used for the test. [optional]
request SyntheticsTestRequest [optional]
steps [SyntheticsAPIStep] When the test subtype is `multi`, the steps of the test. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPITestResultData/index.html b/v1/SyntheticsAPITestResultData/index.html index 650ebbafb1..2ad967fb7b 100644 --- a/v1/SyntheticsAPITestResultData/index.html +++ b/v1/SyntheticsAPITestResultData/index.html @@ -1 +1 @@ - SyntheticsAPITestResultData - Datadog API Client for Python

SyntheticsAPITestResultData

Object containing results for your Synthetic API test.

Properties

Name Type Description Notes
cert SyntheticsSSLCertificate [optional]
error_code SyntheticsErrorCode [optional]
error_message str The API test error message. [optional]
event_type SyntheticsTestProcessStatus [optional]
http_status_code int The API test HTTP status code. [optional]
request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional]
response_body str Response body returned for the API test. [optional]
response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional]
response_size int Global size in byte of the API test response. [optional]
timings SyntheticsTiming [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsAPITestResultData - Datadog API Client for Python

SyntheticsAPITestResultData

Object containing results for your Synthetic API test.

Properties

Name Type Description Notes
cert SyntheticsSSLCertificate [optional]
error_code SyntheticsErrorCode [optional]
error_message str The API test error message. [optional]
event_type SyntheticsTestProcessStatus [optional]
http_status_code int The API test HTTP status code. [optional]
request_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Request header object used for the API test. [optional]
response_body str Response body returned for the API test. [optional]
response_headers {str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)} Response headers returned for the API test. [optional]
response_size int Global size in byte of the API test response. [optional]
timings SyntheticsTiming [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPITestResultFull/index.html b/v1/SyntheticsAPITestResultFull/index.html index 11232ab7c9..cf03d0b7b6 100644 --- a/v1/SyntheticsAPITestResultFull/index.html +++ b/v1/SyntheticsAPITestResultFull/index.html @@ -1 +1 @@ - SyntheticsAPITestResultFull - Datadog API Client for Python

SyntheticsAPITestResultFull

Object returned describing a API test result.

Properties

Name Type Description Notes
check SyntheticsAPITestResultFullCheck [optional]
check_time float When the API test was conducted. [optional]
check_version int Version of the API test used. [optional]
probe_dc str Locations for which to query the API test results. [optional]
result SyntheticsAPITestResultData [optional]
result_id str ID of the API test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsAPITestResultFull - Datadog API Client for Python

SyntheticsAPITestResultFull

Object returned describing a API test result.

Properties

Name Type Description Notes
check SyntheticsAPITestResultFullCheck [optional]
check_time float When the API test was conducted. [optional]
check_version int Version of the API test used. [optional]
probe_dc str Locations for which to query the API test results. [optional]
result SyntheticsAPITestResultData [optional]
result_id str ID of the API test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAPITestResultFullCheck/index.html b/v1/SyntheticsAPITestResultFullCheck/index.html index 88a73ac569..bb5d20cee5 100644 --- a/v1/SyntheticsAPITestResultFullCheck/index.html +++ b/v1/SyntheticsAPITestResultFullCheck/index.html @@ -1 +1 @@ - SyntheticsAPITestResultFullCheck - Datadog API Client for Python
\ No newline at end of file + SyntheticsAPITestResultFullCheck - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAPITestResultShort/index.html b/v1/SyntheticsAPITestResultShort/index.html index 4668136f7f..9394156e00 100644 --- a/v1/SyntheticsAPITestResultShort/index.html +++ b/v1/SyntheticsAPITestResultShort/index.html @@ -1 +1 @@ - SyntheticsAPITestResultShort - Datadog API Client for Python

SyntheticsAPITestResultShort

Object with the results of a single Synthetic API test.

Properties

Name Type Description Notes
check_time float Last time the API test was performed. [optional]
probe_dc str Location from which the API test was performed. [optional]
result SyntheticsAPITestResultShortResult [optional]
result_id str ID of the API test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsAPITestResultShort - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAPITestResultShortResult/index.html b/v1/SyntheticsAPITestResultShortResult/index.html index 90297cb2f8..e71df9829d 100644 --- a/v1/SyntheticsAPITestResultShortResult/index.html +++ b/v1/SyntheticsAPITestResultShortResult/index.html @@ -1 +1 @@ - SyntheticsAPITestResultShortResult - Datadog API Client for Python
\ No newline at end of file + SyntheticsAPITestResultShortResult - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAPITestType/index.html b/v1/SyntheticsAPITestType/index.html index 6965c5ad24..2b47f943aa 100644 --- a/v1/SyntheticsAPITestType/index.html +++ b/v1/SyntheticsAPITestType/index.html @@ -1 +1 @@ - SyntheticsAPITestType - Datadog API Client for Python
\ No newline at end of file + SyntheticsAPITestType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAssertion/index.html b/v1/SyntheticsAssertion/index.html index 7c222bfb71..8f3dbfc227 100644 --- a/v1/SyntheticsAssertion/index.html +++ b/v1/SyntheticsAssertion/index.html @@ -1 +1 @@ - SyntheticsAssertion - Datadog API Client for Python

SyntheticsAssertion

Object describing the assertions type, their associated operator, which property they apply, and upon which target.

Properties

Name Type Description Notes
_property str The associated assertion property. [optional]
target SyntheticsAssertionJSONPathTargetTarget [optional]
operator SyntheticsAssertionJSONPathOperator [optional]
type SyntheticsAssertionType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + SyntheticsAssertion - Datadog API Client for Python

SyntheticsAssertion

Object describing the assertions type, their associated operator, which property they apply, and upon which target.

Properties

Name Type Description Notes
_property str The associated assertion property. [optional]
target SyntheticsAssertionJSONPathTargetTarget [optional]
operator SyntheticsAssertionJSONPathOperator [optional]
type SyntheticsAssertionType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAssertionJSONPathOperator/index.html b/v1/SyntheticsAssertionJSONPathOperator/index.html index 89dde8c039..2356038dfd 100644 --- a/v1/SyntheticsAssertionJSONPathOperator/index.html +++ b/v1/SyntheticsAssertionJSONPathOperator/index.html @@ -1 +1 @@ - SyntheticsAssertionJSONPathOperator - Datadog API Client for Python

SyntheticsAssertionJSONPathOperator

Assertion operator to apply.

Properties

Name Type Description Notes
value str Assertion operator to apply. defaults to "validatesJSONPath", must be one of ["validatesJSONPath", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsAssertionJSONPathOperator - Datadog API Client for Python

SyntheticsAssertionJSONPathOperator

Assertion operator to apply.

Properties

Name Type Description Notes
value str Assertion operator to apply. defaults to "validatesJSONPath", must be one of ["validatesJSONPath", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAssertionJSONPathTarget/index.html b/v1/SyntheticsAssertionJSONPathTarget/index.html index 51cb9c8d88..d4fbdc36f1 100644 --- a/v1/SyntheticsAssertionJSONPathTarget/index.html +++ b/v1/SyntheticsAssertionJSONPathTarget/index.html @@ -1 +1 @@ - SyntheticsAssertionJSONPathTarget - Datadog API Client for Python
\ No newline at end of file + SyntheticsAssertionJSONPathTarget - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAssertionJSONPathTargetTarget/index.html b/v1/SyntheticsAssertionJSONPathTargetTarget/index.html index 49ac3066fa..89bb39f7fe 100644 --- a/v1/SyntheticsAssertionJSONPathTargetTarget/index.html +++ b/v1/SyntheticsAssertionJSONPathTargetTarget/index.html @@ -1 +1 @@ - SyntheticsAssertionJSONPathTargetTarget - Datadog API Client for Python

SyntheticsAssertionJSONPathTargetTarget

Composed target for validatesJSONPath operator.

Properties

Name Type Description Notes
json_path str The JSON path to assert. [optional]
operator str The specific operator to use on the path. [optional]
target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsAssertionJSONPathTargetTarget - Datadog API Client for Python

SyntheticsAssertionJSONPathTargetTarget

Composed target for validatesJSONPath operator.

Properties

Name Type Description Notes
json_path str The JSON path to assert. [optional]
operator str The specific operator to use on the path. [optional]
target_value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The path target value to compare to. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAssertionOperator/index.html b/v1/SyntheticsAssertionOperator/index.html index 478be1f5d8..e294c31b9d 100644 --- a/v1/SyntheticsAssertionOperator/index.html +++ b/v1/SyntheticsAssertionOperator/index.html @@ -1 +1 @@ - SyntheticsAssertionOperator - Datadog API Client for Python

SyntheticsAssertionOperator

Assertion operator to apply.

Properties

Name Type Description Notes
value str Assertion operator to apply. must be one of ["contains", "doesNotContain", "is", "isNot", "lessThan", "lessThanOrEqual", "moreThan", "moreThanOrEqual", "matches", "doesNotMatch", "validates", "isInMoreThan", "isInLessThan", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 10, 2020
\ No newline at end of file + SyntheticsAssertionOperator - Datadog API Client for Python

SyntheticsAssertionOperator

Assertion operator to apply.

Properties

Name Type Description Notes
value str Assertion operator to apply. must be one of ["contains", "doesNotContain", "is", "isNot", "lessThan", "lessThanOrEqual", "moreThan", "moreThanOrEqual", "matches", "doesNotMatch", "validates", "isInMoreThan", "isInLessThan", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsAssertionTarget/index.html b/v1/SyntheticsAssertionTarget/index.html index 136bcab110..69b56da188 100644 --- a/v1/SyntheticsAssertionTarget/index.html +++ b/v1/SyntheticsAssertionTarget/index.html @@ -1 +1 @@ - SyntheticsAssertionTarget - Datadog API Client for Python
\ No newline at end of file + SyntheticsAssertionTarget - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsAssertionType/index.html b/v1/SyntheticsAssertionType/index.html index cef10d4e0e..65c704bbb5 100644 --- a/v1/SyntheticsAssertionType/index.html +++ b/v1/SyntheticsAssertionType/index.html @@ -1 +1 @@ - SyntheticsAssertionType - Datadog API Client for Python

SyntheticsAssertionType

Type of the assertion.

Properties

Name Type Description Notes
value str Type of the assertion. must be one of ["body", "header", "statusCode", "certificate", "responseTime", "property", "recordEvery", "recordSome", "tlsVersion", "minTlsVersion", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 16, 2021
\ No newline at end of file + SyntheticsAssertionType - Datadog API Client for Python

SyntheticsAssertionType

Type of the assertion.

Properties

Name Type Description Notes
value str Type of the assertion. must be one of ["body", "header", "statusCode", "certificate", "responseTime", "property", "recordEvery", "recordSome", "tlsVersion", "minTlsVersion", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBasicAuth/index.html b/v1/SyntheticsBasicAuth/index.html index 5dce00887f..ff5a3526ef 100644 --- a/v1/SyntheticsBasicAuth/index.html +++ b/v1/SyntheticsBasicAuth/index.html @@ -1 +1 @@ - SyntheticsBasicAuth - Datadog API Client for Python

SyntheticsBasicAuth

Object to handle basic authentication when performing the test.

Properties

Name Type Description Notes
password str Password to use for the basic authentication.
username str Username to use for the basic authentication.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBasicAuth - Datadog API Client for Python

SyntheticsBasicAuth

Object to handle basic authentication when performing the test.

Properties

Name Type Description Notes
password str Password to use for the basic authentication.
username str Username to use for the basic authentication.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserError/index.html b/v1/SyntheticsBrowserError/index.html index 29446498c6..379be233a6 100644 --- a/v1/SyntheticsBrowserError/index.html +++ b/v1/SyntheticsBrowserError/index.html @@ -1 +1 @@ - SyntheticsBrowserError - Datadog API Client for Python
\ No newline at end of file + SyntheticsBrowserError - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsBrowserErrorType/index.html b/v1/SyntheticsBrowserErrorType/index.html index a147ed9aec..feb972c712 100644 --- a/v1/SyntheticsBrowserErrorType/index.html +++ b/v1/SyntheticsBrowserErrorType/index.html @@ -1 +1 @@ - SyntheticsBrowserErrorType - Datadog API Client for Python

SyntheticsBrowserErrorType

Error type returned by a browser test.

Properties

Name Type Description Notes
value str Error type returned by a browser test. must be one of ["network", "js", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBrowserErrorType - Datadog API Client for Python

SyntheticsBrowserErrorType

Error type returned by a browser test.

Properties

Name Type Description Notes
value str Error type returned by a browser test. must be one of ["network", "js", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestConfig/index.html b/v1/SyntheticsBrowserTestConfig/index.html index 860146bacd..6a0c4d9227 100644 --- a/v1/SyntheticsBrowserTestConfig/index.html +++ b/v1/SyntheticsBrowserTestConfig/index.html @@ -1 +1 @@ - SyntheticsBrowserTestConfig - Datadog API Client for Python
\ No newline at end of file + SyntheticsBrowserTestConfig - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestResultData/index.html b/v1/SyntheticsBrowserTestResultData/index.html index f8112f83a6..64c0336766 100644 --- a/v1/SyntheticsBrowserTestResultData/index.html +++ b/v1/SyntheticsBrowserTestResultData/index.html @@ -1 +1 @@ - SyntheticsBrowserTestResultData - Datadog API Client for Python

SyntheticsBrowserTestResultData

Object containing results for your Synthetic browser test.

Properties

Name Type Description Notes
browser_type str Type of browser device used for the browser test. [optional]
browser_version str Browser version used for the browser test. [optional]
device SyntheticsDevice [optional]
duration float Global duration in second of the browser test. [optional]
error str Error returned for the browser test. [optional]
passed bool Whether or not the browser test was conducted. [optional]
received_email_count int The amount of email received during the browser test. [optional]
start_url str Starting URL for the browser test. [optional]
step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional]
thumbnails_bucket_key bool Whether or not a thumbnail is associated with the browser test. [optional]
time_to_interactive float Time in second to wait before the browser test starts after reaching the start URL. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBrowserTestResultData - Datadog API Client for Python

SyntheticsBrowserTestResultData

Object containing results for your Synthetic browser test.

Properties

Name Type Description Notes
browser_type str Type of browser device used for the browser test. [optional]
browser_version str Browser version used for the browser test. [optional]
device SyntheticsDevice [optional]
duration float Global duration in second of the browser test. [optional]
error str Error returned for the browser test. [optional]
passed bool Whether or not the browser test was conducted. [optional]
received_email_count int The amount of email received during the browser test. [optional]
start_url str Starting URL for the browser test. [optional]
step_details [SyntheticsStepDetail] Array containing the different browser test steps. [optional]
thumbnails_bucket_key bool Whether or not a thumbnail is associated with the browser test. [optional]
time_to_interactive float Time in second to wait before the browser test starts after reaching the start URL. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestResultFull/index.html b/v1/SyntheticsBrowserTestResultFull/index.html index 9713bc73dd..519d222f2d 100644 --- a/v1/SyntheticsBrowserTestResultFull/index.html +++ b/v1/SyntheticsBrowserTestResultFull/index.html @@ -1 +1 @@ - SyntheticsBrowserTestResultFull - Datadog API Client for Python

SyntheticsBrowserTestResultFull

Object returned describing a browser test result.

Properties

Name Type Description Notes
check SyntheticsBrowserTestResultFullCheck [optional]
check_time float When the browser test was conducted. [optional]
check_version int Version of the browser test used. [optional]
probe_dc str Location from which the browser test was performed. [optional]
result SyntheticsBrowserTestResultData [optional]
result_id str ID of the browser test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBrowserTestResultFull - Datadog API Client for Python

SyntheticsBrowserTestResultFull

Object returned describing a browser test result.

Properties

Name Type Description Notes
check SyntheticsBrowserTestResultFullCheck [optional]
check_time float When the browser test was conducted. [optional]
check_version int Version of the browser test used. [optional]
probe_dc str Location from which the browser test was performed. [optional]
result SyntheticsBrowserTestResultData [optional]
result_id str ID of the browser test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestResultFullCheck/index.html b/v1/SyntheticsBrowserTestResultFullCheck/index.html index c0fe761e69..75c6124b52 100644 --- a/v1/SyntheticsBrowserTestResultFullCheck/index.html +++ b/v1/SyntheticsBrowserTestResultFullCheck/index.html @@ -1 +1 @@ - SyntheticsBrowserTestResultFullCheck - Datadog API Client for Python
\ No newline at end of file + SyntheticsBrowserTestResultFullCheck - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestResultShort/index.html b/v1/SyntheticsBrowserTestResultShort/index.html index 28c4e94bd2..6d64ae3a5a 100644 --- a/v1/SyntheticsBrowserTestResultShort/index.html +++ b/v1/SyntheticsBrowserTestResultShort/index.html @@ -1 +1 @@ - SyntheticsBrowserTestResultShort - Datadog API Client for Python

SyntheticsBrowserTestResultShort

Object with the results of a single Synthetic browser test.

Properties

Name Type Description Notes
check_time float Last time the browser test was performed. [optional]
probe_dc str Location from which the Browser test was performed. [optional]
result SyntheticsBrowserTestResultShortResult [optional]
result_id str ID of the browser test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBrowserTestResultShort - Datadog API Client for Python

SyntheticsBrowserTestResultShort

Object with the results of a single Synthetic browser test.

Properties

Name Type Description Notes
check_time float Last time the browser test was performed. [optional]
probe_dc str Location from which the Browser test was performed. [optional]
result SyntheticsBrowserTestResultShortResult [optional]
result_id str ID of the browser test result. [optional]
status SyntheticsTestMonitorStatus [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestResultShortResult/index.html b/v1/SyntheticsBrowserTestResultShortResult/index.html index 20388ffabb..d85b8770b4 100644 --- a/v1/SyntheticsBrowserTestResultShortResult/index.html +++ b/v1/SyntheticsBrowserTestResultShortResult/index.html @@ -1 +1 @@ - SyntheticsBrowserTestResultShortResult - Datadog API Client for Python

SyntheticsBrowserTestResultShortResult

Object with the result of the last browser test run.

Properties

Name Type Description Notes
device SyntheticsDevice [optional]
duration float Length in second of the browser test run. [optional]
error_count int Amount of errors collected for a single browser test run. [optional]
step_count_completed int Amount of browser test steps completed before failing. [optional]
step_count_total int Total amount of browser test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsBrowserTestResultShortResult - Datadog API Client for Python

SyntheticsBrowserTestResultShortResult

Object with the result of the last browser test run.

Properties

Name Type Description Notes
device SyntheticsDevice [optional]
duration float Length in second of the browser test run. [optional]
error_count int Amount of errors collected for a single browser test run. [optional]
step_count_completed int Amount of browser test steps completed before failing. [optional]
step_count_total int Total amount of browser test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserTestType/index.html b/v1/SyntheticsBrowserTestType/index.html index 45eabd4953..ec008cb6da 100644 --- a/v1/SyntheticsBrowserTestType/index.html +++ b/v1/SyntheticsBrowserTestType/index.html @@ -1 +1 @@ - SyntheticsBrowserTestType - Datadog API Client for Python

SyntheticsBrowserTestType

Type of the Synthetic test, browser.

Properties

Name Type Description Notes
value str Type of the Synthetic test, `browser`. defaults to "browser", must be one of ["browser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 2, 2021
\ No newline at end of file + SyntheticsBrowserTestType - Datadog API Client for Python

SyntheticsBrowserTestType

Type of the Synthetic test, browser.

Properties

Name Type Description Notes
value str Type of the Synthetic test, `browser`. defaults to "browser", must be one of ["browser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsBrowserVariable/index.html b/v1/SyntheticsBrowserVariable/index.html index bc21144caa..619dc231df 100644 --- a/v1/SyntheticsBrowserVariable/index.html +++ b/v1/SyntheticsBrowserVariable/index.html @@ -1 +1 @@ - SyntheticsBrowserVariable - Datadog API Client for Python
\ No newline at end of file + SyntheticsBrowserVariable - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsBrowserVariableType/index.html b/v1/SyntheticsBrowserVariableType/index.html index 366738b2dd..53e71ff752 100644 --- a/v1/SyntheticsBrowserVariableType/index.html +++ b/v1/SyntheticsBrowserVariableType/index.html @@ -1 +1 @@ - SyntheticsBrowserVariableType - Datadog API Client for Python

SyntheticsBrowserVariableType

Type of browser test variable.

Properties

Name Type Description Notes
value str Type of browser test variable. must be one of ["element", "email", "global", "javascript", "text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 17, 2020
\ No newline at end of file + SyntheticsBrowserVariableType - Datadog API Client for Python

SyntheticsBrowserVariableType

Type of browser test variable.

Properties

Name Type Description Notes
value str Type of browser test variable. must be one of ["element", "email", "global", "javascript", "text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsCITest/index.html b/v1/SyntheticsCITest/index.html index f073385661..4254005ad6 100644 --- a/v1/SyntheticsCITest/index.html +++ b/v1/SyntheticsCITest/index.html @@ -1 +1 @@ - SyntheticsCITest - Datadog API Client for Python

SyntheticsCITest

Test configuration for Synthetics CI

Properties

Name Type Description Notes
public_id str The public ID of the Synthetics test to trigger.
allow_insecure_certificates bool Disable certificate checks in API tests. [optional]
basic_auth SyntheticsBasicAuth [optional]
body str Body to include in the test. [optional]
body_type str Type of the data sent in a synthetics API test. [optional]
cookies str Cookies for the request. [optional]
device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional]
follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional]
headers SyntheticsTestHeaders [optional]
locations [str] Array of locations used to run the test. [optional]
metadata SyntheticsCITestMetadata [optional]
retry SyntheticsTestOptionsRetry [optional]
start_url str Starting URL for the browser test. [optional]
variables {str: (str,)} Variables to replace in the test. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsCITest - Datadog API Client for Python

SyntheticsCITest

Test configuration for Synthetics CI

Properties

Name Type Description Notes
public_id str The public ID of the Synthetics test to trigger.
allow_insecure_certificates bool Disable certificate checks in API tests. [optional]
basic_auth SyntheticsBasicAuth [optional]
body str Body to include in the test. [optional]
body_type str Type of the data sent in a synthetics API test. [optional]
cookies str Cookies for the request. [optional]
device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional]
follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional]
headers SyntheticsTestHeaders [optional]
locations [str] Array of locations used to run the test. [optional]
metadata SyntheticsCITestMetadata [optional]
retry SyntheticsTestOptionsRetry [optional]
start_url str Starting URL for the browser test. [optional]
variables {str: (str,)} Variables to replace in the test. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsCITestBody/index.html b/v1/SyntheticsCITestBody/index.html index 065d1d3cf3..329ff07e5d 100644 --- a/v1/SyntheticsCITestBody/index.html +++ b/v1/SyntheticsCITestBody/index.html @@ -1 +1 @@ - SyntheticsCITestBody - Datadog API Client for Python
\ No newline at end of file + SyntheticsCITestBody - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsCITestMetadata/index.html b/v1/SyntheticsCITestMetadata/index.html index 837d5a8b63..446ba3b514 100644 --- a/v1/SyntheticsCITestMetadata/index.html +++ b/v1/SyntheticsCITestMetadata/index.html @@ -1 +1 @@ - SyntheticsCITestMetadata - Datadog API Client for Python
\ No newline at end of file + SyntheticsCITestMetadata - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsCITestMetadataCi/index.html b/v1/SyntheticsCITestMetadataCi/index.html index f33abda5d1..172198a642 100644 --- a/v1/SyntheticsCITestMetadataCi/index.html +++ b/v1/SyntheticsCITestMetadataCi/index.html @@ -1 +1 @@ - SyntheticsCITestMetadataCi - Datadog API Client for Python
\ No newline at end of file + SyntheticsCITestMetadataCi - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsCITestMetadataGit/index.html b/v1/SyntheticsCITestMetadataGit/index.html index 45eeb8f028..798c56bebd 100644 --- a/v1/SyntheticsCITestMetadataGit/index.html +++ b/v1/SyntheticsCITestMetadataGit/index.html @@ -1 +1 @@ - SyntheticsCITestMetadataGit - Datadog API Client for Python
\ No newline at end of file + SyntheticsCITestMetadataGit - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsCheckType/index.html b/v1/SyntheticsCheckType/index.html index c42e354acf..adaefe68ac 100644 --- a/v1/SyntheticsCheckType/index.html +++ b/v1/SyntheticsCheckType/index.html @@ -1 +1 @@ - SyntheticsCheckType - Datadog API Client for Python

SyntheticsCheckType

Type of assertion to apply in an API test.

Properties

Name Type Description Notes
value str Type of assertion to apply in an API test. must be one of ["equals", "notEquals", "contains", "notContains", "startsWith", "notStartsWith", "greater", "lower", "greaterEquals", "lowerEquals", "matchRegex", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsCheckType - Datadog API Client for Python

SyntheticsCheckType

Type of assertion to apply in an API test.

Properties

Name Type Description Notes
value str Type of assertion to apply in an API test. must be one of ["equals", "notEquals", "contains", "notContains", "startsWith", "notStartsWith", "greater", "lower", "greaterEquals", "lowerEquals", "matchRegex", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsConfigVariable/index.html b/v1/SyntheticsConfigVariable/index.html index 71dea4d832..210c08d76c 100644 --- a/v1/SyntheticsConfigVariable/index.html +++ b/v1/SyntheticsConfigVariable/index.html @@ -1 +1 @@ - SyntheticsConfigVariable - Datadog API Client for Python
\ No newline at end of file + SyntheticsConfigVariable - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsConfigVariableType/index.html b/v1/SyntheticsConfigVariableType/index.html index f471824b2e..40f3f409cb 100644 --- a/v1/SyntheticsConfigVariableType/index.html +++ b/v1/SyntheticsConfigVariableType/index.html @@ -1 +1 @@ - SyntheticsConfigVariableType - Datadog API Client for Python

SyntheticsConfigVariableType

Type of the configuration variable.

Properties

Name Type Description Notes
value str Type of the configuration variable. defaults to "text", must be one of ["text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 24, 2020
\ No newline at end of file + SyntheticsConfigVariableType - Datadog API Client for Python

SyntheticsConfigVariableType

Type of the configuration variable.

Properties

Name Type Description Notes
value str Type of the configuration variable. defaults to "text", must be one of ["text", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsCoreWebVitals/index.html b/v1/SyntheticsCoreWebVitals/index.html index 5c29471a75..526a58130c 100644 --- a/v1/SyntheticsCoreWebVitals/index.html +++ b/v1/SyntheticsCoreWebVitals/index.html @@ -1 +1 @@ - SyntheticsCoreWebVitals - Datadog API Client for Python

SyntheticsCoreWebVitals

Core Web Vitals attached to a browser test step.

Properties

Name Type Description Notes
cls int Cumulative Layout Shift. [optional]
lcp int Largest Contentful Paint in milliseconds. [optional]
url str URL attached to the metrics. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + SyntheticsCoreWebVitals - Datadog API Client for Python

SyntheticsCoreWebVitals

Core Web Vitals attached to a browser test step.

Properties

Name Type Description Notes
cls int Cumulative Layout Shift. [optional]
lcp int Largest Contentful Paint in milliseconds. [optional]
url str URL attached to the metrics. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsDeleteTestsPayload/index.html b/v1/SyntheticsDeleteTestsPayload/index.html index d62686284e..46bcf9be83 100644 --- a/v1/SyntheticsDeleteTestsPayload/index.html +++ b/v1/SyntheticsDeleteTestsPayload/index.html @@ -1 +1 @@ - SyntheticsDeleteTestsPayload - Datadog API Client for Python

SyntheticsDeleteTestsPayload

A JSON list of the ID or IDs of the Synthetic tests that you want to delete.

Properties

Name Type Description Notes
public_ids [str] An array of Synthetic test IDs you want to delete. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsDeleteTestsPayload - Datadog API Client for Python

SyntheticsDeleteTestsPayload

A JSON list of the ID or IDs of the Synthetic tests that you want to delete.

Properties

Name Type Description Notes
public_ids [str] An array of Synthetic test IDs you want to delete. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsDeleteTestsResponse/index.html b/v1/SyntheticsDeleteTestsResponse/index.html index 7d97fe452c..ffbee26045 100644 --- a/v1/SyntheticsDeleteTestsResponse/index.html +++ b/v1/SyntheticsDeleteTestsResponse/index.html @@ -1 +1 @@ - SyntheticsDeleteTestsResponse - Datadog API Client for Python
\ No newline at end of file + SyntheticsDeleteTestsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsDeletedTest/index.html b/v1/SyntheticsDeletedTest/index.html index d0aaa72700..0d0cc2c3dc 100644 --- a/v1/SyntheticsDeletedTest/index.html +++ b/v1/SyntheticsDeletedTest/index.html @@ -1 +1 @@ - SyntheticsDeletedTest - Datadog API Client for Python

SyntheticsDeletedTest

Object containing a deleted Synthetic test ID with the associated deletion timestamp.

Properties

Name Type Description Notes
deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional]
public_id str The Synthetic test ID deleted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + SyntheticsDeletedTest - Datadog API Client for Python

SyntheticsDeletedTest

Object containing a deleted Synthetic test ID with the associated deletion timestamp.

Properties

Name Type Description Notes
deleted_at datetime Deletion timestamp of the Synthetic test ID. [optional]
public_id str The Synthetic test ID deleted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsDevice/index.html b/v1/SyntheticsDevice/index.html index 13090bbe92..a2c3d7d3b1 100644 --- a/v1/SyntheticsDevice/index.html +++ b/v1/SyntheticsDevice/index.html @@ -1 +1 @@ - SyntheticsDevice - Datadog API Client for Python

SyntheticsDevice

Object describing the device used to perform the Synthetic test.

Properties

Name Type Description Notes
height int Screen height of the device.
id SyntheticsDeviceID
name str The device name.
width int Screen width of the device.
is_mobile bool Whether or not the device is a mobile. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsDevice - Datadog API Client for Python

SyntheticsDevice

Object describing the device used to perform the Synthetic test.

Properties

Name Type Description Notes
height int Screen height of the device.
id SyntheticsDeviceID
name str The device name.
width int Screen width of the device.
is_mobile bool Whether or not the device is a mobile. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsDeviceID/index.html b/v1/SyntheticsDeviceID/index.html index fe1ec66a29..34b2fa22de 100644 --- a/v1/SyntheticsDeviceID/index.html +++ b/v1/SyntheticsDeviceID/index.html @@ -1 +1 @@ - SyntheticsDeviceID - Datadog API Client for Python

SyntheticsDeviceID

The device ID.

Properties

Name Type Description Notes
value str The device ID. must be one of ["laptop_large", "tablet", "mobile_small", "chrome.laptop_large", "chrome.tablet", "chrome.mobile_small", "firefox.laptop_large", "firefox.tablet", "firefox.mobile_small", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsDeviceID - Datadog API Client for Python

SyntheticsDeviceID

The device ID.

Properties

Name Type Description Notes
value str The device ID. must be one of ["laptop_large", "tablet", "mobile_small", "chrome.laptop_large", "chrome.tablet", "chrome.mobile_small", "firefox.laptop_large", "firefox.tablet", "firefox.mobile_small", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsErrorCode/index.html b/v1/SyntheticsErrorCode/index.html index 554e4aaa1f..23dc57b656 100644 --- a/v1/SyntheticsErrorCode/index.html +++ b/v1/SyntheticsErrorCode/index.html @@ -1 +1 @@ - SyntheticsErrorCode - Datadog API Client for Python

SyntheticsErrorCode

Error code that can be returned by a Synthetic test.

Properties

Name Type Description Notes
value str Error code that can be returned by a Synthetic test. must be one of ["NO_ERROR", "UNKNOWN", "DNS", "SSL", "TIMEOUT", "DENIED", "INCORRECT_ASSERTION", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsErrorCode - Datadog API Client for Python

SyntheticsErrorCode

Error code that can be returned by a Synthetic test.

Properties

Name Type Description Notes
value str Error code that can be returned by a Synthetic test. must be one of ["NO_ERROR", "UNKNOWN", "DNS", "SSL", "TIMEOUT", "DENIED", "INCORRECT_ASSERTION", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsGetAPITestLatestResultsResponse/index.html b/v1/SyntheticsGetAPITestLatestResultsResponse/index.html index cee331c55b..1139a6246d 100644 --- a/v1/SyntheticsGetAPITestLatestResultsResponse/index.html +++ b/v1/SyntheticsGetAPITestLatestResultsResponse/index.html @@ -1 +1 @@ - SyntheticsGetAPITestLatestResultsResponse - Datadog API Client for Python
\ No newline at end of file + SyntheticsGetAPITestLatestResultsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsGetBrowserTestLatestResultsResponse/index.html b/v1/SyntheticsGetBrowserTestLatestResultsResponse/index.html index 358baa7cdd..1ec446539f 100644 --- a/v1/SyntheticsGetBrowserTestLatestResultsResponse/index.html +++ b/v1/SyntheticsGetBrowserTestLatestResultsResponse/index.html @@ -1 +1 @@ - SyntheticsGetBrowserTestLatestResultsResponse - Datadog API Client for Python
\ No newline at end of file + SyntheticsGetBrowserTestLatestResultsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsGlobalVariable/index.html b/v1/SyntheticsGlobalVariable/index.html index cba3524d74..ada9f35d45 100644 --- a/v1/SyntheticsGlobalVariable/index.html +++ b/v1/SyntheticsGlobalVariable/index.html @@ -1 +1 @@ - SyntheticsGlobalVariable - Datadog API Client for Python

SyntheticsGlobalVariable

Synthetics global variable.

Properties

Name Type Description Notes
description str Description of the global variable.
name str Name of the global variable.
tags [str] Tags of the global variable.
value SyntheticsGlobalVariableValue
id str Unique identifier of the global variable. [optional][readonly]
parse_test_options SyntheticsGlobalVariableParseTestOptions [optional]
parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 8, 2021
\ No newline at end of file + SyntheticsGlobalVariable - Datadog API Client for Python

SyntheticsGlobalVariable

Synthetics global variable.

Properties

Name Type Description Notes
description str Description of the global variable.
name str Name of the global variable.
tags [str] Tags of the global variable.
value SyntheticsGlobalVariableValue
id str Unique identifier of the global variable. [optional][readonly]
parse_test_options SyntheticsGlobalVariableParseTestOptions [optional]
parse_test_public_id str A Synthetic test ID to use as a test to generate the variable value. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsGlobalVariableParseTestOptions/index.html b/v1/SyntheticsGlobalVariableParseTestOptions/index.html index ba66c76afe..32c069adb3 100644 --- a/v1/SyntheticsGlobalVariableParseTestOptions/index.html +++ b/v1/SyntheticsGlobalVariableParseTestOptions/index.html @@ -1 +1 @@ - SyntheticsGlobalVariableParseTestOptions - Datadog API Client for Python
\ No newline at end of file + SyntheticsGlobalVariableParseTestOptions - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsGlobalVariableParseTestOptionsType/index.html b/v1/SyntheticsGlobalVariableParseTestOptionsType/index.html index 41b888aba5..d5385c7f67 100644 --- a/v1/SyntheticsGlobalVariableParseTestOptionsType/index.html +++ b/v1/SyntheticsGlobalVariableParseTestOptionsType/index.html @@ -1 +1 @@ - SyntheticsGlobalVariableParseTestOptionsType - Datadog API Client for Python

SyntheticsGlobalVariableParseTestOptionsType

Property of the Synthetics Test Response to use for a Synthetics global variable.

Properties

Name Type Description Notes
value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of ["http_body", "http_header", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 8, 2021
\ No newline at end of file + SyntheticsGlobalVariableParseTestOptionsType - Datadog API Client for Python

SyntheticsGlobalVariableParseTestOptionsType

Property of the Synthetics Test Response to use for a Synthetics global variable.

Properties

Name Type Description Notes
value str Property of the Synthetics Test Response to use for a Synthetics global variable. must be one of ["http_body", "http_header", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsGlobalVariableParserType/index.html b/v1/SyntheticsGlobalVariableParserType/index.html index dd2a50e4d1..74a28db8d8 100644 --- a/v1/SyntheticsGlobalVariableParserType/index.html +++ b/v1/SyntheticsGlobalVariableParserType/index.html @@ -1 +1 @@ - SyntheticsGlobalVariableParserType - Datadog API Client for Python

SyntheticsGlobalVariableParserType

Type of parser for a Synthetics global variable from a synthetics test.

Properties

Name Type Description Notes
value str Type of parser for a Synthetics global variable from a synthetics test. must be one of ["raw", "json_path", "regex", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 8, 2021
\ No newline at end of file + SyntheticsGlobalVariableParserType - Datadog API Client for Python

SyntheticsGlobalVariableParserType

Type of parser for a Synthetics global variable from a synthetics test.

Properties

Name Type Description Notes
value str Type of parser for a Synthetics global variable from a synthetics test. must be one of ["raw", "json_path", "regex", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsGlobalVariableValue/index.html b/v1/SyntheticsGlobalVariableValue/index.html index 2bd5533dc9..68c7fba44b 100644 --- a/v1/SyntheticsGlobalVariableValue/index.html +++ b/v1/SyntheticsGlobalVariableValue/index.html @@ -1 +1 @@ - SyntheticsGlobalVariableValue - Datadog API Client for Python

SyntheticsGlobalVariableValue

Value of the global variable.

Properties

Name Type Description Notes
value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure.
secure bool Determines if the variable is secure. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 28, 2020
\ No newline at end of file + SyntheticsGlobalVariableValue - Datadog API Client for Python

SyntheticsGlobalVariableValue

Value of the global variable.

Properties

Name Type Description Notes
value str Value of the global variable. When reading a global variable, the value will not be present if the variable is secure.
secure bool Determines if the variable is secure. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsListTestsResponse/index.html b/v1/SyntheticsListTestsResponse/index.html index 147daa1997..ad882cc002 100644 --- a/v1/SyntheticsListTestsResponse/index.html +++ b/v1/SyntheticsListTestsResponse/index.html @@ -1 +1 @@ - SyntheticsListTestsResponse - Datadog API Client for Python
\ No newline at end of file + SyntheticsListTestsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsLocation/index.html b/v1/SyntheticsLocation/index.html index 55a8439900..bce93639f7 100644 --- a/v1/SyntheticsLocation/index.html +++ b/v1/SyntheticsLocation/index.html @@ -1 +1 @@ - SyntheticsLocation - Datadog API Client for Python

SyntheticsLocation

Synthetic location that can be used when creating or editing a test.

Properties

Name Type Description Notes
id str Unique identifier of the location. [optional]
name str Name of the location. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 1, 2020
\ No newline at end of file + SyntheticsLocation - Datadog API Client for Python

SyntheticsLocation

Synthetic location that can be used when creating or editing a test.

Properties

Name Type Description Notes
id str Unique identifier of the location. [optional]
name str Name of the location. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsLocations/index.html b/v1/SyntheticsLocations/index.html index d6e4d9400a..9e62baddb1 100644 --- a/v1/SyntheticsLocations/index.html +++ b/v1/SyntheticsLocations/index.html @@ -1 +1 @@ - SyntheticsLocations - Datadog API Client for Python
\ No newline at end of file + SyntheticsLocations - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsParsingOptions/index.html b/v1/SyntheticsParsingOptions/index.html index 0caecbdf14..7d43210a78 100644 --- a/v1/SyntheticsParsingOptions/index.html +++ b/v1/SyntheticsParsingOptions/index.html @@ -1 +1 @@ - SyntheticsParsingOptions - Datadog API Client for Python
\ No newline at end of file + SyntheticsParsingOptions - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsPlayingTab/index.html b/v1/SyntheticsPlayingTab/index.html index 5c3bb2e55e..be49f58edc 100644 --- a/v1/SyntheticsPlayingTab/index.html +++ b/v1/SyntheticsPlayingTab/index.html @@ -1 +1 @@ - SyntheticsPlayingTab - Datadog API Client for Python

SyntheticsPlayingTab

Navigate between different tabs for your browser test.

Properties

Name Type Description Notes
value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsPlayingTab - Datadog API Client for Python

SyntheticsPlayingTab

Navigate between different tabs for your browser test.

Properties

Name Type Description Notes
value int Navigate between different tabs for your browser test. must be one of [-1, 0, 1, 2, 3, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocation/index.html b/v1/SyntheticsPrivateLocation/index.html index 62fa289101..ec17a07385 100644 --- a/v1/SyntheticsPrivateLocation/index.html +++ b/v1/SyntheticsPrivateLocation/index.html @@ -1 +1 @@ - SyntheticsPrivateLocation - Datadog API Client for Python

SyntheticsPrivateLocation

Object containing information about the private location to create.

Properties

Name Type Description Notes
description str Description of the private location.
name str Name of the private location.
tags [str] Array of tags attached to the private location.
id str Unique identifier of the private location. [optional][readonly]
secrets SyntheticsPrivateLocationSecrets [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 23, 2020
\ No newline at end of file + SyntheticsPrivateLocation - Datadog API Client for Python

SyntheticsPrivateLocation

Object containing information about the private location to create.

Properties

Name Type Description Notes
description str Description of the private location.
name str Name of the private location.
tags [str] Array of tags attached to the private location.
id str Unique identifier of the private location. [optional][readonly]
secrets SyntheticsPrivateLocationSecrets [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocationCreationResponse/index.html b/v1/SyntheticsPrivateLocationCreationResponse/index.html index 066dfb1c68..ba35f33f95 100644 --- a/v1/SyntheticsPrivateLocationCreationResponse/index.html +++ b/v1/SyntheticsPrivateLocationCreationResponse/index.html @@ -1 +1 @@ - SyntheticsPrivateLocationCreationResponse - Datadog API Client for Python

SyntheticsPrivateLocationCreationResponse

Object that contains the new private location, the public key for result encryption, and the configuration skeleton.

Properties

Name Type Description Notes
config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional]
private_location SyntheticsPrivateLocation [optional]
result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 23, 2020
\ No newline at end of file + SyntheticsPrivateLocationCreationResponse - Datadog API Client for Python

SyntheticsPrivateLocationCreationResponse

Object that contains the new private location, the public key for result encryption, and the configuration skeleton.

Properties

Name Type Description Notes
config {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. [optional]
private_location SyntheticsPrivateLocation [optional]
result_encryption SyntheticsPrivateLocationCreationResponseResultEncryption [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocationCreationResponseResultEncryption/index.html b/v1/SyntheticsPrivateLocationCreationResponseResultEncryption/index.html index 9bbedfef8a..11bc2a5a1d 100644 --- a/v1/SyntheticsPrivateLocationCreationResponseResultEncryption/index.html +++ b/v1/SyntheticsPrivateLocationCreationResponseResultEncryption/index.html @@ -1 +1 @@ - SyntheticsPrivateLocationCreationResponseResultEncryption - Datadog API Client for Python

SyntheticsPrivateLocationCreationResponseResultEncryption

Public key for the result encryption.

Properties

Name Type Description Notes
id str Fingerprint for the encryption key. [optional]
key str Public key for result encryption. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 23, 2020
\ No newline at end of file + SyntheticsPrivateLocationCreationResponseResultEncryption - Datadog API Client for Python

SyntheticsPrivateLocationCreationResponseResultEncryption

Public key for the result encryption.

Properties

Name Type Description Notes
id str Fingerprint for the encryption key. [optional]
key str Public key for result encryption. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocationSecrets/index.html b/v1/SyntheticsPrivateLocationSecrets/index.html index 42ae94b070..e20784eb91 100644 --- a/v1/SyntheticsPrivateLocationSecrets/index.html +++ b/v1/SyntheticsPrivateLocationSecrets/index.html @@ -1 +1 @@ - SyntheticsPrivateLocationSecrets - Datadog API Client for Python
\ No newline at end of file + SyntheticsPrivateLocationSecrets - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocationSecretsAuthentication/index.html b/v1/SyntheticsPrivateLocationSecretsAuthentication/index.html index 9325252724..597353d6f0 100644 --- a/v1/SyntheticsPrivateLocationSecretsAuthentication/index.html +++ b/v1/SyntheticsPrivateLocationSecretsAuthentication/index.html @@ -1 +1 @@ - SyntheticsPrivateLocationSecretsAuthentication - Datadog API Client for Python

SyntheticsPrivateLocationSecretsAuthentication

Authentication part of the secrets.

Properties

Name Type Description Notes
id str Access key for the private location. [optional][readonly]
key str Secret access key for the private location. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 23, 2020
\ No newline at end of file + SyntheticsPrivateLocationSecretsAuthentication - Datadog API Client for Python

SyntheticsPrivateLocationSecretsAuthentication

Authentication part of the secrets.

Properties

Name Type Description Notes
id str Access key for the private location. [optional][readonly]
key str Secret access key for the private location. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsPrivateLocationSecretsConfigDecryption/index.html b/v1/SyntheticsPrivateLocationSecretsConfigDecryption/index.html index d566bb7b42..ea7abbdc78 100644 --- a/v1/SyntheticsPrivateLocationSecretsConfigDecryption/index.html +++ b/v1/SyntheticsPrivateLocationSecretsConfigDecryption/index.html @@ -1 +1 @@ - SyntheticsPrivateLocationSecretsConfigDecryption - Datadog API Client for Python

SyntheticsPrivateLocationSecretsConfigDecryption

Private key for the private location.

Properties

Name Type Description Notes
key str Private key for the private location. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 23, 2020
\ No newline at end of file + SyntheticsPrivateLocationSecretsConfigDecryption - Datadog API Client for Python

SyntheticsPrivateLocationSecretsConfigDecryption

Private key for the private location.

Properties

Name Type Description Notes
key str Private key for the private location. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsSSLCertificate/index.html b/v1/SyntheticsSSLCertificate/index.html index 7673cfb500..8a2e43fb93 100644 --- a/v1/SyntheticsSSLCertificate/index.html +++ b/v1/SyntheticsSSLCertificate/index.html @@ -1 +1 @@ - SyntheticsSSLCertificate - Datadog API Client for Python

SyntheticsSSLCertificate

Object describing the SSL certificate used for a Synthetic test.

Properties

Name Type Description Notes
cipher str Cipher used for the connection. [optional]
exponent float Exponent associated to the certificate. [optional]
ext_key_usage [str] Array of extensions and details used for the certificate. [optional]
fingerprint str MD5 digest of the DER-encoded Certificate information. [optional]
fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional]
issuer SyntheticsSSLCertificateIssuer [optional]
modulus str Modulus associated to the SSL certificate private key. [optional]
protocol str TLS protocol used for the test. [optional]
serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional]
subject SyntheticsSSLCertificateSubject [optional]
valid_from datetime Date from which the SSL certificate is valid. [optional]
valid_to datetime Date until which the SSL certificate is valid. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsSSLCertificate - Datadog API Client for Python

SyntheticsSSLCertificate

Object describing the SSL certificate used for a Synthetic test.

Properties

Name Type Description Notes
cipher str Cipher used for the connection. [optional]
exponent float Exponent associated to the certificate. [optional]
ext_key_usage [str] Array of extensions and details used for the certificate. [optional]
fingerprint str MD5 digest of the DER-encoded Certificate information. [optional]
fingerprint256 str SHA-1 digest of the DER-encoded Certificate information. [optional]
issuer SyntheticsSSLCertificateIssuer [optional]
modulus str Modulus associated to the SSL certificate private key. [optional]
protocol str TLS protocol used for the test. [optional]
serial_number str Serial Number assigned by Symantec to the SSL certificate. [optional]
subject SyntheticsSSLCertificateSubject [optional]
valid_from datetime Date from which the SSL certificate is valid. [optional]
valid_to datetime Date until which the SSL certificate is valid. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsSSLCertificateIssuer/index.html b/v1/SyntheticsSSLCertificateIssuer/index.html index fe11b535c9..9edb5eb018 100644 --- a/v1/SyntheticsSSLCertificateIssuer/index.html +++ b/v1/SyntheticsSSLCertificateIssuer/index.html @@ -1 +1 @@ - SyntheticsSSLCertificateIssuer - Datadog API Client for Python

SyntheticsSSLCertificateIssuer

Object describing the issuer of a SSL certificate.

Properties

Name Type Description Notes
c str Country Name that issued the certificate. [optional]
cn str Common Name that issued certificate. [optional]
l str Locality that issued the certificate. [optional]
o str Organization that issued the certificate. [optional]
ou str Organizational Unit that issued the certificate. [optional]
st str State Or Province Name that issued the certificate. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsSSLCertificateIssuer - Datadog API Client for Python

SyntheticsSSLCertificateIssuer

Object describing the issuer of a SSL certificate.

Properties

Name Type Description Notes
c str Country Name that issued the certificate. [optional]
cn str Common Name that issued certificate. [optional]
l str Locality that issued the certificate. [optional]
o str Organization that issued the certificate. [optional]
ou str Organizational Unit that issued the certificate. [optional]
st str State Or Province Name that issued the certificate. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsSSLCertificateSubject/index.html b/v1/SyntheticsSSLCertificateSubject/index.html index 70b710ff76..f2dd3fa0ef 100644 --- a/v1/SyntheticsSSLCertificateSubject/index.html +++ b/v1/SyntheticsSSLCertificateSubject/index.html @@ -1 +1 @@ - SyntheticsSSLCertificateSubject - Datadog API Client for Python

SyntheticsSSLCertificateSubject

Object describing the SSL certificate used for the test.

Properties

Name Type Description Notes
c str Country Name associated with the certificate. [optional]
cn str Common Name that associated with the certificate. [optional]
l str Locality associated with the certificate. [optional]
o str Organization associated with the certificate. [optional]
ou str Organizational Unit associated with the certificate. [optional]
st str State Or Province Name associated with the certificate. [optional]
alt_name str Subject Alternative Name associated with the certificate. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsSSLCertificateSubject - Datadog API Client for Python

SyntheticsSSLCertificateSubject

Object describing the SSL certificate used for the test.

Properties

Name Type Description Notes
c str Country Name associated with the certificate. [optional]
cn str Common Name that associated with the certificate. [optional]
l str Locality associated with the certificate. [optional]
o str Organization associated with the certificate. [optional]
ou str Organizational Unit associated with the certificate. [optional]
st str State Or Province Name associated with the certificate. [optional]
alt_name str Subject Alternative Name associated with the certificate. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsStep/index.html b/v1/SyntheticsStep/index.html index 9a8d33bcff..f9156a1860 100644 --- a/v1/SyntheticsStep/index.html +++ b/v1/SyntheticsStep/index.html @@ -1 +1 @@ - SyntheticsStep - Datadog API Client for Python

SyntheticsStep

The steps used in a Synthetics browser test.

Properties

Name Type Description Notes
allow_failure bool A boolean set to allow this step to fail. [optional]
name str The name of the step. [optional]
params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional]
timeout int The time before declaring a step failed. [optional]
type SyntheticsStepType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 14, 2021
\ No newline at end of file + SyntheticsStep - Datadog API Client for Python

SyntheticsStep

The steps used in a Synthetics browser test.

Properties

Name Type Description Notes
allow_failure bool A boolean set to allow this step to fail. [optional]
name str The name of the step. [optional]
params {str: (bool, date, datetime, dict, float, int, list, str, none_type)} The parameters of the step. [optional]
timeout int The time before declaring a step failed. [optional]
type SyntheticsStepType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsStepDetail/index.html b/v1/SyntheticsStepDetail/index.html index 00c6929331..9f3fb46d34 100644 --- a/v1/SyntheticsStepDetail/index.html +++ b/v1/SyntheticsStepDetail/index.html @@ -1 +1 @@ - SyntheticsStepDetail - Datadog API Client for Python

SyntheticsStepDetail

Object describing a step for a Synthetic test.

Properties

Name Type Description Notes
browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional]
check_type SyntheticsCheckType [optional]
description str Description of the test. [optional]
duration float Total duration in millisecond of the test. [optional]
error str Error returned by the test. [optional]
playing_tab SyntheticsPlayingTab [optional]
screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional]
skipped bool Whether or not to skip this step. [optional]
snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional]
step_id int The step ID. [optional]
sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation. [optional]
time_to_interactive float Time before starting the step. [optional]
type SyntheticsStepType [optional]
url str URL to perform the step against. [optional]
value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional]
vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional]
warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + SyntheticsStepDetail - Datadog API Client for Python

SyntheticsStepDetail

Object describing a step for a Synthetic test.

Properties

Name Type Description Notes
browser_errors [SyntheticsBrowserError] Array of errors collected for a browser test. [optional]
check_type SyntheticsCheckType [optional]
description str Description of the test. [optional]
duration float Total duration in millisecond of the test. [optional]
error str Error returned by the test. [optional]
playing_tab SyntheticsPlayingTab [optional]
screenshot_bucket_key bool Whether or not screenshots where collected by the test. [optional]
skipped bool Whether or not to skip this step. [optional]
snapshot_bucket_key bool Whether or not snapshots where collected by the test. [optional]
step_id int The step ID. [optional]
sub_test_step_details [SyntheticsStepDetail] If this steps include a sub-test. Subtests documentation. [optional]
time_to_interactive float Time before starting the step. [optional]
type SyntheticsStepType [optional]
url str URL to perform the step against. [optional]
value {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Value for the step. [optional]
vitals_metrics [SyntheticsCoreWebVitals] Array of Core Web Vitals metrics for the step. [optional]
warnings [SyntheticsStepDetailWarning] Warning collected that didn't failed the step. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsStepDetailWarning/index.html b/v1/SyntheticsStepDetailWarning/index.html index 8bba1bf1a6..3254b4f6e3 100644 --- a/v1/SyntheticsStepDetailWarning/index.html +++ b/v1/SyntheticsStepDetailWarning/index.html @@ -1 +1 @@ - SyntheticsStepDetailWarning - Datadog API Client for Python
\ No newline at end of file + SyntheticsStepDetailWarning - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsStepType/index.html b/v1/SyntheticsStepType/index.html index a377052ccd..3b9459960b 100644 --- a/v1/SyntheticsStepType/index.html +++ b/v1/SyntheticsStepType/index.html @@ -1 +1 @@ - SyntheticsStepType - Datadog API Client for Python

SyntheticsStepType

Step type used in your Synthetic test.

Properties

Name Type Description Notes
value str Step type used in your Synthetic test. must be one of ["assertCurrentUrl", "assertElementAttribute", "assertElementContent", "assertElementPresent", "assertEmail", "assertFileDownload", "assertFromJavascript", "assertPageContains", "assertPageLacks", "click", "extractFromJavascript", "extractVariable", "goToEmailLink", "goToUrl", "goToUrlAndMeasureTti", "hover", "playSubTest", "pressKey", "refresh", "runApiTest", "scroll", "selectOption", "typeText", "uploadFiles", "wait", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 23, 2020
\ No newline at end of file + SyntheticsStepType - Datadog API Client for Python

SyntheticsStepType

Step type used in your Synthetic test.

Properties

Name Type Description Notes
value str Step type used in your Synthetic test. must be one of ["assertCurrentUrl", "assertElementAttribute", "assertElementContent", "assertElementPresent", "assertEmail", "assertFileDownload", "assertFromJavascript", "assertPageContains", "assertPageLacks", "click", "extractFromJavascript", "extractVariable", "goToEmailLink", "goToUrl", "goToUrlAndMeasureTti", "hover", "playSubTest", "pressKey", "refresh", "runApiTest", "scroll", "selectOption", "typeText", "uploadFiles", "wait", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestConfig/index.html b/v1/SyntheticsTestConfig/index.html index 4835587b98..a520b90998 100644 --- a/v1/SyntheticsTestConfig/index.html +++ b/v1/SyntheticsTestConfig/index.html @@ -1 +1 @@ - SyntheticsTestConfig - Datadog API Client for Python

SyntheticsTestConfig

Configuration object for a Synthetic test.

Properties

Name Type Description Notes
request SyntheticsTestRequest
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional]
variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 24, 2020
\ No newline at end of file + SyntheticsTestConfig - Datadog API Client for Python

SyntheticsTestConfig

Configuration object for a Synthetic test.

Properties

Name Type Description Notes
request SyntheticsTestRequest
assertions [SyntheticsAssertion] Array of assertions used for the test. defaults to []
config_variables [SyntheticsConfigVariable] API tests only - array of variables used for the test. [optional]
variables [SyntheticsBrowserVariable] Browser tests only - array of variables used for the test steps. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestDetails/index.html b/v1/SyntheticsTestDetails/index.html index 2cafab9025..c02fc739a7 100644 --- a/v1/SyntheticsTestDetails/index.html +++ b/v1/SyntheticsTestDetails/index.html @@ -1 +1 @@ - SyntheticsTestDetails - Datadog API Client for Python

SyntheticsTestDetails

Object containing details about your Synthetic test.

Properties

Name Type Description Notes
config SyntheticsTestConfig [optional]
locations [str] Array of locations used to run the test. [optional]
message str Notification message associated with the test. [optional]
monitor_id int The associated monitor ID. [optional]
name str Name of the test. [optional]
options SyntheticsTestOptions [optional]
public_id str The test public ID. [optional]
status SyntheticsTestPauseStatus [optional]
steps [SyntheticsStep] For browser test, the steps of the test. [optional]
subtype SyntheticsTestDetailsSubType [optional]
tags [str] Array of tags attached to the test. [optional]
type SyntheticsTestDetailsType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestDetails - Datadog API Client for Python

SyntheticsTestDetails

Object containing details about your Synthetic test.

Properties

Name Type Description Notes
config SyntheticsTestConfig [optional]
locations [str] Array of locations used to run the test. [optional]
message str Notification message associated with the test. [optional]
monitor_id int The associated monitor ID. [optional]
name str Name of the test. [optional]
options SyntheticsTestOptions [optional]
public_id str The test public ID. [optional]
status SyntheticsTestPauseStatus [optional]
steps [SyntheticsStep] For browser test, the steps of the test. [optional]
subtype SyntheticsTestDetailsSubType [optional]
tags [str] Array of tags attached to the test. [optional]
type SyntheticsTestDetailsType [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestDetailsSubType/index.html b/v1/SyntheticsTestDetailsSubType/index.html index dbeb0ca864..681f4c8323 100644 --- a/v1/SyntheticsTestDetailsSubType/index.html +++ b/v1/SyntheticsTestDetailsSubType/index.html @@ -1 +1 @@ - SyntheticsTestDetailsSubType - Datadog API Client for Python

SyntheticsTestDetailsSubType

The subtype of the Synthetic API test, http, ssl, tcp, dns or multi.

Properties

Name Type Description Notes
value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns` or `multi`. must be one of ["http", "ssl", "tcp", "dns", "multi", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + SyntheticsTestDetailsSubType - Datadog API Client for Python

SyntheticsTestDetailsSubType

The subtype of the Synthetic API test, http, ssl, tcp, dns or multi.

Properties

Name Type Description Notes
value str The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns` or `multi`. must be one of ["http", "ssl", "tcp", "dns", "multi", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestDetailsType/index.html b/v1/SyntheticsTestDetailsType/index.html index 69b3a495b6..89e9cb17df 100644 --- a/v1/SyntheticsTestDetailsType/index.html +++ b/v1/SyntheticsTestDetailsType/index.html @@ -1 +1 @@ - SyntheticsTestDetailsType - Datadog API Client for Python

SyntheticsTestDetailsType

Type of the Synthetic test, either api or browser.

Properties

Name Type Description Notes
value str Type of the Synthetic test, either `api` or `browser`. must be one of ["api", "browser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestDetailsType - Datadog API Client for Python

SyntheticsTestDetailsType

Type of the Synthetic test, either api or browser.

Properties

Name Type Description Notes
value str Type of the Synthetic test, either `api` or `browser`. must be one of ["api", "browser", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestHeaders/index.html b/v1/SyntheticsTestHeaders/index.html index a7a7d15169..8a6a114e88 100644 --- a/v1/SyntheticsTestHeaders/index.html +++ b/v1/SyntheticsTestHeaders/index.html @@ -1 +1 @@ - SyntheticsTestHeaders - Datadog API Client for Python

SyntheticsTestHeaders

Headers to include when performing the test.

Properties

Name Type Description Notes
any string name str any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestHeaders - Datadog API Client for Python

SyntheticsTestHeaders

Headers to include when performing the test.

Properties

Name Type Description Notes
any string name str any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestMonitorStatus/index.html b/v1/SyntheticsTestMonitorStatus/index.html index 622bf96f58..abd65af948 100644 --- a/v1/SyntheticsTestMonitorStatus/index.html +++ b/v1/SyntheticsTestMonitorStatus/index.html @@ -1 +1 @@ - SyntheticsTestMonitorStatus - Datadog API Client for Python

SyntheticsTestMonitorStatus

The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data

Properties

Name Type Description Notes
value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestMonitorStatus - Datadog API Client for Python

SyntheticsTestMonitorStatus

The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data

Properties

Name Type Description Notes
value int The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data must be one of [0, 1, 2, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestOptions/index.html b/v1/SyntheticsTestOptions/index.html index 9c41f8f5d3..52d06d8935 100644 --- a/v1/SyntheticsTestOptions/index.html +++ b/v1/SyntheticsTestOptions/index.html @@ -1 +1 @@ - SyntheticsTestOptions - Datadog API Client for Python

SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Properties

Name Type Description Notes
accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional]
allow_insecure bool Allows loading insecure content for an HTTP request. [optional]
device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional]
follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional]
min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional]
min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional]
monitor_options SyntheticsTestOptionsMonitorOptions [optional]
retry SyntheticsTestOptionsRetry [optional]
tick_every SyntheticsTickInterval [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestOptions - Datadog API Client for Python

SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Properties

Name Type Description Notes
accept_self_signed bool For SSL test, whether or not the test should allow self signed certificates. [optional]
allow_insecure bool Allows loading insecure content for an HTTP request. [optional]
device_ids [SyntheticsDeviceID] For browser test, array with the different device IDs used to run the test. [optional]
follow_redirects bool For API HTTP test, whether or not the test should follow redirects. [optional]
min_failure_duration int Minimum amount of time in failure required to trigger an alert. [optional]
min_location_failed int Minimum number of locations in failure required to trigger an alert. [optional]
monitor_options SyntheticsTestOptionsMonitorOptions [optional]
retry SyntheticsTestOptionsRetry [optional]
tick_every SyntheticsTickInterval [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestOptionsMonitorOptions/index.html b/v1/SyntheticsTestOptionsMonitorOptions/index.html index 6b59760202..0baa12da9e 100644 --- a/v1/SyntheticsTestOptionsMonitorOptions/index.html +++ b/v1/SyntheticsTestOptionsMonitorOptions/index.html @@ -1 +1 @@ - SyntheticsTestOptionsMonitorOptions - Datadog API Client for Python

SyntheticsTestOptionsMonitorOptions

Object containing the options for a Synthetic test as a monitor (for example, renotification).

Properties

Name Type Description Notes
renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 1, 2020
\ No newline at end of file + SyntheticsTestOptionsMonitorOptions - Datadog API Client for Python

SyntheticsTestOptionsMonitorOptions

Object containing the options for a Synthetic test as a monitor (for example, renotification).

Properties

Name Type Description Notes
renotify_interval int Time interval before renotifying if the test is still failing (in minutes). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestOptionsRetry/index.html b/v1/SyntheticsTestOptionsRetry/index.html index cf9d1dc623..d16908b2e1 100644 --- a/v1/SyntheticsTestOptionsRetry/index.html +++ b/v1/SyntheticsTestOptionsRetry/index.html @@ -1 +1 @@ - SyntheticsTestOptionsRetry - Datadog API Client for Python

SyntheticsTestOptionsRetry

Object describing the retry strategy to apply to a Synthetic test.

Properties

Name Type Description Notes
count int Number of times a test needs to be retried before marking a location as failed. Defaults to 0. [optional]
interval float Time interval between retries (in milliseconds). Defaults to 300ms. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestOptionsRetry - Datadog API Client for Python

SyntheticsTestOptionsRetry

Object describing the retry strategy to apply to a Synthetic test.

Properties

Name Type Description Notes
count int Number of times a test needs to be retried before marking a location as failed. Defaults to 0. [optional]
interval float Time interval between retries (in milliseconds). Defaults to 300ms. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestPauseStatus/index.html b/v1/SyntheticsTestPauseStatus/index.html index d13a7b0ca0..980fb66fda 100644 --- a/v1/SyntheticsTestPauseStatus/index.html +++ b/v1/SyntheticsTestPauseStatus/index.html @@ -1 +1 @@ - SyntheticsTestPauseStatus - Datadog API Client for Python

SyntheticsTestPauseStatus

Define whether you want to start (live) or pause (paused) a Synthetic test.

Properties

Name Type Description Notes
value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of ["live", "paused", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestPauseStatus - Datadog API Client for Python

SyntheticsTestPauseStatus

Define whether you want to start (live) or pause (paused) a Synthetic test.

Properties

Name Type Description Notes
value str Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. must be one of ["live", "paused", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestProcessStatus/index.html b/v1/SyntheticsTestProcessStatus/index.html index 9141bd2f59..1f84c81049 100644 --- a/v1/SyntheticsTestProcessStatus/index.html +++ b/v1/SyntheticsTestProcessStatus/index.html @@ -1 +1 @@ - SyntheticsTestProcessStatus - Datadog API Client for Python

SyntheticsTestProcessStatus

Status of a Synthetic test.

Properties

Name Type Description Notes
value str Status of a Synthetic test. must be one of ["not_scheduled", "scheduled", "started", "finished", "finished_with_error", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTestProcessStatus - Datadog API Client for Python

SyntheticsTestProcessStatus

Status of a Synthetic test.

Properties

Name Type Description Notes
value str Status of a Synthetic test. must be one of ["not_scheduled", "scheduled", "started", "finished", "finished_with_error", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestRequest/index.html b/v1/SyntheticsTestRequest/index.html index 065a3d6249..bd91917e39 100644 --- a/v1/SyntheticsTestRequest/index.html +++ b/v1/SyntheticsTestRequest/index.html @@ -1 +1 @@ - SyntheticsTestRequest - Datadog API Client for Python

SyntheticsTestRequest

Object describing the Synthetic test request.

Properties

Name Type Description Notes
basic_auth SyntheticsBasicAuth [optional]
body str Body to include in the test. [optional]
certificate SyntheticsTestRequestCertificate [optional]
dns_server str DNS server to use for DNS tests. [optional]
headers SyntheticsTestHeaders [optional]
host str Host name to perform the test with. [optional]
method HTTPMethod [optional]
port int Port to use when performing the test. [optional]
query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional]
timeout float Timeout in seconds for the test. [optional]
url str URL to perform the test with. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 19, 2020
\ No newline at end of file + SyntheticsTestRequest - Datadog API Client for Python

SyntheticsTestRequest

Object describing the Synthetic test request.

Properties

Name Type Description Notes
basic_auth SyntheticsBasicAuth [optional]
body str Body to include in the test. [optional]
certificate SyntheticsTestRequestCertificate [optional]
dns_server str DNS server to use for DNS tests. [optional]
headers SyntheticsTestHeaders [optional]
host str Host name to perform the test with. [optional]
method HTTPMethod [optional]
port int Port to use when performing the test. [optional]
query {str: (bool, date, datetime, dict, float, int, list, str, none_type)} Query to use for the test. [optional]
timeout float Timeout in seconds for the test. [optional]
url str URL to perform the test with. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTestRequestCertificate/index.html b/v1/SyntheticsTestRequestCertificate/index.html index 41e6020985..a5fb716150 100644 --- a/v1/SyntheticsTestRequestCertificate/index.html +++ b/v1/SyntheticsTestRequestCertificate/index.html @@ -1 +1 @@ - SyntheticsTestRequestCertificate - Datadog API Client for Python
\ No newline at end of file + SyntheticsTestRequestCertificate - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsTestRequestCertificateItem/index.html b/v1/SyntheticsTestRequestCertificateItem/index.html index a344f885da..4a5c04df59 100644 --- a/v1/SyntheticsTestRequestCertificateItem/index.html +++ b/v1/SyntheticsTestRequestCertificateItem/index.html @@ -1 +1 @@ - SyntheticsTestRequestCertificateItem - Datadog API Client for Python

SyntheticsTestRequestCertificateItem

Define a request certificate.

Properties

Name Type Description Notes
content str Content of the certificate or key. [optional]
filename str File name for the certificate or key. [optional]
updated_at str Date of update of the certificate or key, ISO format. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 19, 2020
\ No newline at end of file + SyntheticsTestRequestCertificateItem - Datadog API Client for Python

SyntheticsTestRequestCertificateItem

Define a request certificate.

Properties

Name Type Description Notes
content str Content of the certificate or key. [optional]
filename str File name for the certificate or key. [optional]
updated_at str Date of update of the certificate or key, ISO format. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTickInterval/index.html b/v1/SyntheticsTickInterval/index.html index 57e2aa895c..2eca3ad264 100644 --- a/v1/SyntheticsTickInterval/index.html +++ b/v1/SyntheticsTickInterval/index.html @@ -1 +1 @@ - SyntheticsTickInterval - Datadog API Client for Python

SyntheticsTickInterval

The frequency at which to run the Synthetic test (in seconds).

Properties

Name Type Description Notes
value int The frequency at which to run the Synthetic test (in seconds). must be one of [60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTickInterval - Datadog API Client for Python

SyntheticsTickInterval

The frequency at which to run the Synthetic test (in seconds).

Properties

Name Type Description Notes
value int The frequency at which to run the Synthetic test (in seconds). must be one of [60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTiming/index.html b/v1/SyntheticsTiming/index.html index 025c5bcb1d..23c7fca52e 100644 --- a/v1/SyntheticsTiming/index.html +++ b/v1/SyntheticsTiming/index.html @@ -1 +1 @@ - SyntheticsTiming - Datadog API Client for Python

SyntheticsTiming

Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation.

Properties

Name Type Description Notes
dns float The duration in millisecond of the DNS lookup. [optional]
download float The time in millisecond to download the response. [optional]
first_byte float The time in millisecond to first byte. [optional]
handshake float The duration in millisecond of the TLS handshake. [optional]
redirect float The time in millisecond spent during redirections. [optional]
ssl float The duration in millisecond of the TLS handshake. [optional]
tcp float Time in millisecond to establish the TCP connection. [optional]
total float The overall time in millisecond the request took to be processed. [optional]
wait float Time spent in millisecond waiting for a response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SyntheticsTiming - Datadog API Client for Python

SyntheticsTiming

Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation.

Properties

Name Type Description Notes
dns float The duration in millisecond of the DNS lookup. [optional]
download float The time in millisecond to download the response. [optional]
first_byte float The time in millisecond to first byte. [optional]
handshake float The duration in millisecond of the TLS handshake. [optional]
redirect float The time in millisecond spent during redirections. [optional]
ssl float The duration in millisecond of the TLS handshake. [optional]
tcp float Time in millisecond to establish the TCP connection. [optional]
total float The overall time in millisecond the request took to be processed. [optional]
wait float Time spent in millisecond waiting for a response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTriggerCITestLocation/index.html b/v1/SyntheticsTriggerCITestLocation/index.html index 77736fa5e6..5ae3fe9604 100644 --- a/v1/SyntheticsTriggerCITestLocation/index.html +++ b/v1/SyntheticsTriggerCITestLocation/index.html @@ -1 +1 @@ - SyntheticsTriggerCITestLocation - Datadog API Client for Python

SyntheticsTriggerCITestLocation

Synthetics location.

Properties

Name Type Description Notes
id int Unique identifier of the location. [optional]
name str Name of the location. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + SyntheticsTriggerCITestLocation - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsTriggerCITestRunResult/index.html b/v1/SyntheticsTriggerCITestRunResult/index.html index 8c874d77a4..b5ab71fec8 100644 --- a/v1/SyntheticsTriggerCITestRunResult/index.html +++ b/v1/SyntheticsTriggerCITestRunResult/index.html @@ -1 +1 @@ - SyntheticsTriggerCITestRunResult - Datadog API Client for Python

SyntheticsTriggerCITestRunResult

Information about a single test run.

Properties

Name Type Description Notes
device SyntheticsDeviceID [optional]
location int The location ID of the test run. [optional]
public_id str The public ID of the Synthetics test. [optional]
result_id str ID of the result. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + SyntheticsTriggerCITestRunResult - Datadog API Client for Python

SyntheticsTriggerCITestRunResult

Information about a single test run.

Properties

Name Type Description Notes
device SyntheticsDeviceID [optional]
location int The location ID of the test run. [optional]
public_id str The public ID of the Synthetics test. [optional]
result_id str ID of the result. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/SyntheticsTriggerCITestsResponse/index.html b/v1/SyntheticsTriggerCITestsResponse/index.html index 5d318b268a..283f5fabd1 100644 --- a/v1/SyntheticsTriggerCITestsResponse/index.html +++ b/v1/SyntheticsTriggerCITestsResponse/index.html @@ -1 +1 @@ - SyntheticsTriggerCITestsResponse - Datadog API Client for Python
\ No newline at end of file + SyntheticsTriggerCITestsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsUpdateTestPauseStatusPayload/index.html b/v1/SyntheticsUpdateTestPauseStatusPayload/index.html index ee94c1522a..c1ee157268 100644 --- a/v1/SyntheticsUpdateTestPauseStatusPayload/index.html +++ b/v1/SyntheticsUpdateTestPauseStatusPayload/index.html @@ -1 +1 @@ - SyntheticsUpdateTestPauseStatusPayload - Datadog API Client for Python
\ No newline at end of file + SyntheticsUpdateTestPauseStatusPayload - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsVariableParser/index.html b/v1/SyntheticsVariableParser/index.html index 98991657b8..f424ed0bd1 100644 --- a/v1/SyntheticsVariableParser/index.html +++ b/v1/SyntheticsVariableParser/index.html @@ -1 +1 @@ - SyntheticsVariableParser - Datadog API Client for Python
\ No newline at end of file + SyntheticsVariableParser - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/SyntheticsWarningType/index.html b/v1/SyntheticsWarningType/index.html index 6899e6328b..ab903b5f0b 100644 --- a/v1/SyntheticsWarningType/index.html +++ b/v1/SyntheticsWarningType/index.html @@ -1 +1 @@ - SyntheticsWarningType - Datadog API Client for Python
\ No newline at end of file + SyntheticsWarningType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/TableWidgetCellDisplayMode/index.html b/v1/TableWidgetCellDisplayMode/index.html index 1e5f3074ae..8890ca505c 100644 --- a/v1/TableWidgetCellDisplayMode/index.html +++ b/v1/TableWidgetCellDisplayMode/index.html @@ -1 +1 @@ - TableWidgetCellDisplayMode - Datadog API Client for Python

TableWidgetCellDisplayMode

Define a display mode for the table cell.

Properties

Name Type Description Notes
value str Define a display mode for the table cell. must be one of ["number", "bar", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 15, 2020
\ No newline at end of file + TableWidgetCellDisplayMode - Datadog API Client for Python

TableWidgetCellDisplayMode

Define a display mode for the table cell.

Properties

Name Type Description Notes
value str Define a display mode for the table cell. must be one of ["number", "bar", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TableWidgetDefinition/index.html b/v1/TableWidgetDefinition/index.html index 38fda8ad16..a47b8dad01 100644 --- a/v1/TableWidgetDefinition/index.html +++ b/v1/TableWidgetDefinition/index.html @@ -1 +1 @@ - TableWidgetDefinition - Datadog API Client for Python

TableWidgetDefinition

The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.

Properties

Name Type Description Notes
requests [TableWidgetRequest] Widget definition.
type TableWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
has_search_bar TableWidgetHasSearchBar [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 2, 2020
\ No newline at end of file + TableWidgetDefinition - Datadog API Client for Python

TableWidgetDefinition

The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.

Properties

Name Type Description Notes
requests [TableWidgetRequest] Widget definition.
type TableWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
has_search_bar TableWidgetHasSearchBar [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TableWidgetDefinitionType/index.html b/v1/TableWidgetDefinitionType/index.html index 6684b54580..8e68317089 100644 --- a/v1/TableWidgetDefinitionType/index.html +++ b/v1/TableWidgetDefinitionType/index.html @@ -1 +1 @@ - TableWidgetDefinitionType - Datadog API Client for Python

TableWidgetDefinitionType

Type of the table widget.

Properties

Name Type Description Notes
value str Type of the table widget. defaults to "query_table", must be one of ["query_table", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + TableWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/TableWidgetHasSearchBar/index.html b/v1/TableWidgetHasSearchBar/index.html index a927569b1a..a1b9d36af8 100644 --- a/v1/TableWidgetHasSearchBar/index.html +++ b/v1/TableWidgetHasSearchBar/index.html @@ -1 +1 @@ - TableWidgetHasSearchBar - Datadog API Client for Python

TableWidgetHasSearchBar

Controls the display of the search bar.

Properties

Name Type Description Notes
value str Controls the display of the search bar. must be one of ["always", "never", "auto", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 8, 2020
\ No newline at end of file + TableWidgetHasSearchBar - Datadog API Client for Python

TableWidgetHasSearchBar

Controls the display of the search bar.

Properties

Name Type Description Notes
value str Controls the display of the search bar. must be one of ["always", "never", "auto", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TableWidgetRequest/index.html b/v1/TableWidgetRequest/index.html index ccc9793ef3..f16ac67e36 100644 --- a/v1/TableWidgetRequest/index.html +++ b/v1/TableWidgetRequest/index.html @@ -1 +1 @@ - TableWidgetRequest - Datadog API Client for Python

TableWidgetRequest

Updated table widget.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
alias str The column name (defaults to the metric name). [optional]
apm_query LogQueryDefinition [optional]
apm_stats_query ApmStatsQueryDefinition [optional]
cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
order WidgetSort [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 15, 2021
\ No newline at end of file + TableWidgetRequest - Datadog API Client for Python

TableWidgetRequest

Updated table widget.

Properties

Name Type Description Notes
aggregator WidgetAggregator [optional]
alias str The column name (defaults to the metric name). [optional]
apm_query LogQueryDefinition [optional]
apm_stats_query ApmStatsQueryDefinition [optional]
cell_display_mode [TableWidgetCellDisplayMode] A list of display modes for each table cell. [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
limit int For metric queries, the number of lines to show in the table. Only one request should have this property. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
order WidgetSort [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Query definition. [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TagToHosts/index.html b/v1/TagToHosts/index.html index aa19012227..36889c2f55 100644 --- a/v1/TagToHosts/index.html +++ b/v1/TagToHosts/index.html @@ -1 +1 @@ - TagToHosts - Datadog API Client for Python

TagToHosts

In this object, the key is the tag, the value is a list of host names that are reporting that tag.

Properties

Name Type Description Notes
tags {str: ([str],)} A list of tags to apply to the host. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + TagToHosts - Datadog API Client for Python

TagToHosts

In this object, the key is the tag, the value is a list of host names that are reporting that tag.

Properties

Name Type Description Notes
tags {str: ([str],)} A list of tags to apply to the host. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TagsApi/index.html b/v1/TagsApi/index.html index 55db798a60..555bb17e80 100644 --- a/v1/TagsApi/index.html +++ b/v1/TagsApi/index.html @@ -209,4 +209,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling TagsApi->update_host_tags: %s\n" % e) -

Parameters

Name Type Description Notes
host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request.
body HostTags Add tags to host
source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional]

Return type

HostTags

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 OK -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
host_name str This endpoint allows you to update/replace all in an integration source with those supplied in the request.
body HostTags Add tags to host
source str The source of the tags (e.g. chef, puppet). Complete list of source attribute values [optional]

Return type

HostTags

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 OK -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TargetFormatType/index.html b/v1/TargetFormatType/index.html index 9f15898cc3..104e9f072d 100644 --- a/v1/TargetFormatType/index.html +++ b/v1/TargetFormatType/index.html @@ -1 +1 @@ - TargetFormatType - Datadog API Client for Python

TargetFormatType

If the target_type of the remapper is attribute, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string, integer, or double are the possible types. If the target_type is tag, this parameter may not be specified.

Properties

Name Type Description Notes
value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of ["auto", "string", "integer", "double", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 9, 2020
\ No newline at end of file + TargetFormatType - Datadog API Client for Python

TargetFormatType

If the target_type of the remapper is attribute, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string, integer, or double are the possible types. If the target_type is tag, this parameter may not be specified.

Properties

Name Type Description Notes
value str If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. must be one of ["auto", "string", "integer", "double", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TimeseriesWidgetDefinition/index.html b/v1/TimeseriesWidgetDefinition/index.html index 6407692ace..cf2002464f 100644 --- a/v1/TimeseriesWidgetDefinition/index.html +++ b/v1/TimeseriesWidgetDefinition/index.html @@ -1 +1 @@ - TimeseriesWidgetDefinition - Datadog API Client for Python

TimeseriesWidgetDefinition

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.

Properties

Name Type Description Notes
requests [TimeseriesWidgetRequest] List of timeseries widget requests.
type TimeseriesWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
events [WidgetEvent] List of widget events. [optional]
legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional]
legend_layout TimeseriesWidgetLegendLayout [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
markers [WidgetMarker] List of markers. [optional]
right_yaxis WidgetAxis [optional]
show_legend bool (screenboard only) Show the legend for this widget. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 18, 2021
\ No newline at end of file + TimeseriesWidgetDefinition - Datadog API Client for Python

TimeseriesWidgetDefinition

The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time.

Properties

Name Type Description Notes
requests [TimeseriesWidgetRequest] List of timeseries widget requests.
type TimeseriesWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
events [WidgetEvent] List of widget events. [optional]
legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional]
legend_layout TimeseriesWidgetLegendLayout [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
markers [WidgetMarker] List of markers. [optional]
right_yaxis WidgetAxis [optional]
show_legend bool (screenboard only) Show the legend for this widget. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
yaxis WidgetAxis [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TimeseriesWidgetDefinitionType/index.html b/v1/TimeseriesWidgetDefinitionType/index.html index 39ee96d12a..1bc3c148f1 100644 --- a/v1/TimeseriesWidgetDefinitionType/index.html +++ b/v1/TimeseriesWidgetDefinitionType/index.html @@ -1 +1 @@ - TimeseriesWidgetDefinitionType - Datadog API Client for Python

TimeseriesWidgetDefinitionType

Type of the timeseries widget.

Properties

Name Type Description Notes
value str Type of the timeseries widget. defaults to "timeseries", must be one of ["timeseries", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + TimeseriesWidgetDefinitionType - Datadog API Client for Python

TimeseriesWidgetDefinitionType

Type of the timeseries widget.

Properties

Name Type Description Notes
value str Type of the timeseries widget. defaults to "timeseries", must be one of ["timeseries", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/TimeseriesWidgetExpressionAlias/index.html b/v1/TimeseriesWidgetExpressionAlias/index.html index 1937426e06..1887456656 100644 --- a/v1/TimeseriesWidgetExpressionAlias/index.html +++ b/v1/TimeseriesWidgetExpressionAlias/index.html @@ -1 +1 @@ - TimeseriesWidgetExpressionAlias - Datadog API Client for Python
\ No newline at end of file + TimeseriesWidgetExpressionAlias - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/TimeseriesWidgetLegendColumn/index.html b/v1/TimeseriesWidgetLegendColumn/index.html index 7e2d06f144..25acd28d87 100644 --- a/v1/TimeseriesWidgetLegendColumn/index.html +++ b/v1/TimeseriesWidgetLegendColumn/index.html @@ -1 +1 @@ - TimeseriesWidgetLegendColumn - Datadog API Client for Python
\ No newline at end of file + TimeseriesWidgetLegendColumn - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/TimeseriesWidgetLegendLayout/index.html b/v1/TimeseriesWidgetLegendLayout/index.html index 3db7dc0e65..3e0c4864d9 100644 --- a/v1/TimeseriesWidgetLegendLayout/index.html +++ b/v1/TimeseriesWidgetLegendLayout/index.html @@ -1 +1 @@ - TimeseriesWidgetLegendLayout - Datadog API Client for Python
\ No newline at end of file + TimeseriesWidgetLegendLayout - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/TimeseriesWidgetRequest/index.html b/v1/TimeseriesWidgetRequest/index.html index 39652e7d9d..f3b50832d4 100644 --- a/v1/TimeseriesWidgetRequest/index.html +++ b/v1/TimeseriesWidgetRequest/index.html @@ -1 +1 @@ - TimeseriesWidgetRequest - Datadog API Client for Python

TimeseriesWidgetRequest

Updated timeseries widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
display_type WidgetDisplayType [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional]
network_query LogQueryDefinition [optional]
on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetRequestStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file + TimeseriesWidgetRequest - Datadog API Client for Python

TimeseriesWidgetRequest

Updated timeseries widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
display_type WidgetDisplayType [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
metadata [TimeseriesWidgetExpressionAlias] Used to define expression aliases. [optional]
network_query LogQueryDefinition [optional]
on_right_yaxis bool Whether or not to display a second y-axis on the right. [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetRequestStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ToplistWidgetDefinition/index.html b/v1/ToplistWidgetDefinition/index.html index 06f6a6bdb1..c43cf374d1 100644 --- a/v1/ToplistWidgetDefinition/index.html +++ b/v1/ToplistWidgetDefinition/index.html @@ -1 +1 @@ - ToplistWidgetDefinition - Datadog API Client for Python

ToplistWidgetDefinition

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

Properties

Name Type Description Notes
requests [ToplistWidgetRequest] List of top list widget requests.
type ToplistWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + ToplistWidgetDefinition - Datadog API Client for Python

ToplistWidgetDefinition

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

Properties

Name Type Description Notes
requests [ToplistWidgetRequest] List of top list widget requests.
type ToplistWidgetDefinitionType
custom_links [WidgetCustomLink] List of custom links. [optional]
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/ToplistWidgetDefinitionType/index.html b/v1/ToplistWidgetDefinitionType/index.html index 48c5d38f3e..99d4c525be 100644 --- a/v1/ToplistWidgetDefinitionType/index.html +++ b/v1/ToplistWidgetDefinitionType/index.html @@ -1 +1 @@ - ToplistWidgetDefinitionType - Datadog API Client for Python

ToplistWidgetDefinitionType

Type of the top list widget.

Properties

Name Type Description Notes
value str Type of the top list widget. defaults to "toplist", must be one of ["toplist", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + ToplistWidgetDefinitionType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/ToplistWidgetRequest/index.html b/v1/ToplistWidgetRequest/index.html index bdf01b88ef..861025424f 100644 --- a/v1/ToplistWidgetRequest/index.html +++ b/v1/ToplistWidgetRequest/index.html @@ -1 +1 @@ - ToplistWidgetRequest - Datadog API Client for Python

ToplistWidgetRequest

Updated top list widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetRequestStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file + ToplistWidgetRequest - Datadog API Client for Python

ToplistWidgetRequest

Updated top list widget.

Properties

Name Type Description Notes
apm_query LogQueryDefinition [optional]
conditional_formats [WidgetConditionalFormat] List of conditional formats. [optional]
event_query LogQueryDefinition [optional]
formulas [WidgetFormula] List of formulas that operate on queries. This feature is currently in beta. [optional]
log_query LogQueryDefinition [optional]
network_query LogQueryDefinition [optional]
process_query ProcessQueryDefinition [optional]
profile_metrics_query LogQueryDefinition [optional]
q str Widget query. [optional]
queries [FormulaAndFunctionQueryDefinition] List of queries that can be returned directly or used in formulas. This feature is currently in beta. [optional]
response_format FormulaAndFunctionResponseFormat [optional]
rum_query LogQueryDefinition [optional]
security_query LogQueryDefinition [optional]
style WidgetRequestStyle [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAnalyzedLogsHour/index.html b/v1/UsageAnalyzedLogsHour/index.html index 21df494341..38ffb5b2b0 100644 --- a/v1/UsageAnalyzedLogsHour/index.html +++ b/v1/UsageAnalyzedLogsHour/index.html @@ -1 +1 @@ - UsageAnalyzedLogsHour - Datadog API Client for Python

UsageAnalyzedLogsHour

The number of analyzed logs for each hour for a given organization.

Properties

Name Type Description Notes
analyzed_logs int Contains the number of analyzed logs. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageAnalyzedLogsHour - Datadog API Client for Python

UsageAnalyzedLogsHour

The number of analyzed logs for each hour for a given organization.

Properties

Name Type Description Notes
analyzed_logs int Contains the number of analyzed logs. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAnalyzedLogsResponse/index.html b/v1/UsageAnalyzedLogsResponse/index.html index 93fd994f23..09fbafab5e 100644 --- a/v1/UsageAnalyzedLogsResponse/index.html +++ b/v1/UsageAnalyzedLogsResponse/index.html @@ -1 +1 @@ - UsageAnalyzedLogsResponse - Datadog API Client for Python
\ No newline at end of file + UsageAnalyzedLogsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageAttributionAggregates/index.html b/v1/UsageAttributionAggregates/index.html index 49eb5785c3..8d8502bb26 100644 --- a/v1/UsageAttributionAggregates/index.html +++ b/v1/UsageAttributionAggregates/index.html @@ -1 +1 @@ - UsageAttributionAggregates - Datadog API Client for Python
\ No newline at end of file + UsageAttributionAggregates - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageAttributionAggregatesBody/index.html b/v1/UsageAttributionAggregatesBody/index.html index 6a3d7e680f..8a0fe6cb50 100644 --- a/v1/UsageAttributionAggregatesBody/index.html +++ b/v1/UsageAttributionAggregatesBody/index.html @@ -1 +1 @@ - UsageAttributionAggregatesBody - Datadog API Client for Python

UsageAttributionAggregatesBody

The object containing the aggregates.

Properties

Name Type Description Notes
agg_type str The aggregate type. [optional]
field str The field. [optional]
value float The value for a given field. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 19, 2020
\ No newline at end of file + UsageAttributionAggregatesBody - Datadog API Client for Python

UsageAttributionAggregatesBody

The object containing the aggregates.

Properties

Name Type Description Notes
agg_type str The aggregate type. [optional]
field str The field. [optional]
value float The value for a given field. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAttributionBody/index.html b/v1/UsageAttributionBody/index.html index f1c0d135de..87c8aca87a 100644 --- a/v1/UsageAttributionBody/index.html +++ b/v1/UsageAttributionBody/index.html @@ -1 +1 @@ - UsageAttributionBody - Datadog API Client for Python

UsageAttributionBody

Usage Summary by tag for a given organization.

Properties

Name Type Description Notes
month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional]
org_name str The name of the organization. [optional]
public_id str The organization public ID. [optional]
tags UsageAttributionTagNames [optional]
updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional]
values UsageAttributionValues [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 18, 2021
\ No newline at end of file + UsageAttributionBody - Datadog API Client for Python

UsageAttributionBody

Usage Summary by tag for a given organization.

Properties

Name Type Description Notes
month datetime Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. [optional]
org_name str The name of the organization. [optional]
public_id str The organization public ID. [optional]
tags UsageAttributionTagNames [optional]
updated_at str Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional]
values UsageAttributionValues [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAttributionMetadata/index.html b/v1/UsageAttributionMetadata/index.html index b93ffbbee8..cd0d65a985 100644 --- a/v1/UsageAttributionMetadata/index.html +++ b/v1/UsageAttributionMetadata/index.html @@ -1 +1 @@ - UsageAttributionMetadata - Datadog API Client for Python
\ No newline at end of file + UsageAttributionMetadata - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageAttributionPagination/index.html b/v1/UsageAttributionPagination/index.html index f598103c48..670ce7c658 100644 --- a/v1/UsageAttributionPagination/index.html +++ b/v1/UsageAttributionPagination/index.html @@ -1 +1 @@ - UsageAttributionPagination - Datadog API Client for Python

UsageAttributionPagination

The page count for the current pagination.

Properties

Name Type Description Notes
limit int Maximum amount of records to be returned. [optional]
offset int Records to be skipped before beginning to return. [optional]
sort_direction str Direction to sort by. [optional]
sort_name str Field to sort by. [optional]
total_number_of_records int Total number of records. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 19, 2020
\ No newline at end of file + UsageAttributionPagination - Datadog API Client for Python

UsageAttributionPagination

The page count for the current pagination.

Properties

Name Type Description Notes
limit int Maximum amount of records to be returned. [optional]
offset int Records to be skipped before beginning to return. [optional]
sort_direction str Direction to sort by. [optional]
sort_name str Field to sort by. [optional]
total_number_of_records int Total number of records. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAttributionResponse/index.html b/v1/UsageAttributionResponse/index.html index 7e6bfb9b86..7f8ecc3e27 100644 --- a/v1/UsageAttributionResponse/index.html +++ b/v1/UsageAttributionResponse/index.html @@ -1 +1 @@ - UsageAttributionResponse - Datadog API Client for Python
\ No newline at end of file + UsageAttributionResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageAttributionSort/index.html b/v1/UsageAttributionSort/index.html index c9a01491cb..ebcdee32a9 100644 --- a/v1/UsageAttributionSort/index.html +++ b/v1/UsageAttributionSort/index.html @@ -1 +1 @@ - UsageAttributionSort - Datadog API Client for Python

UsageAttributionSort

The field to sort by.

Properties

Name Type Description Notes
value str The field to sort by. defaults to "custom_timeseries_usage", must be one of ["api_percentage", "snmp_usage", "apm_host_usage", "api_usage", "container_usage", "custom_timeseries_percentage", "container_percentage", "apm_host_percentage", "npm_host_percentage", "browser_percentage", "browser_usage", "infra_host_percentage", "snmp_percentage", "npm_host_usage", "infra_host_usage", "custom_timeseries_usage", "lambda_functions_usage", "lambda_functions_percentage", "lambda_invocations_usage", "lambda_invocations_percentage", "lambda_usage", "lambda_percentage", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 11, 2021
\ No newline at end of file + UsageAttributionSort - Datadog API Client for Python

UsageAttributionSort

The field to sort by.

Properties

Name Type Description Notes
value str The field to sort by. defaults to "custom_timeseries_usage", must be one of ["api_percentage", "snmp_usage", "apm_host_usage", "api_usage", "container_usage", "custom_timeseries_percentage", "container_percentage", "apm_host_percentage", "npm_host_percentage", "browser_percentage", "browser_usage", "infra_host_percentage", "snmp_percentage", "npm_host_usage", "infra_host_usage", "custom_timeseries_usage", "lambda_functions_usage", "lambda_functions_percentage", "lambda_invocations_usage", "lambda_invocations_percentage", "lambda_usage", "lambda_percentage", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAttributionTagNames/index.html b/v1/UsageAttributionTagNames/index.html index 3fd86d8e51..21c7055fc6 100644 --- a/v1/UsageAttributionTagNames/index.html +++ b/v1/UsageAttributionTagNames/index.html @@ -1 +1 @@ - UsageAttributionTagNames - Datadog API Client for Python

UsageAttributionTagNames

Usage Summary by tag name.

Properties

Name Type Description Notes
any string name [str] any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 19, 2020
\ No newline at end of file + UsageAttributionTagNames - Datadog API Client for Python

UsageAttributionTagNames

Usage Summary by tag name.

Properties

Name Type Description Notes
any string name [str] any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageAttributionValues/index.html b/v1/UsageAttributionValues/index.html index 050c929e3b..313a584300 100644 --- a/v1/UsageAttributionValues/index.html +++ b/v1/UsageAttributionValues/index.html @@ -1 +1 @@ - UsageAttributionValues - Datadog API Client for Python

UsageAttributionValues

Fields in Usage Summary by tag(s).

Properties

Name Type Description Notes
api_percentage float The percentage of synthetic API test usage by tag(s). [optional]
api_usage float The synthetic API test usage by tag(s). [optional]
apm_host_percentage float The percentage of APM host usage by tag(s). [optional]
apm_host_usage float The APM host usage by tag(s). [optional]
browser_percentage float The percentage of synthetic browser test usage by tag(s). [optional]
browser_usage float The synthetic browser test usage by tag(s). [optional]
container_percentage float The percentage of container usage by tag(s). [optional]
container_usage float The container usage by tag(s). [optional]
custom_timeseries_percentage float The percentage of custom metrics usage by tag(s). [optional]
custom_timeseries_usage float The custom metrics usage by tag(s). [optional]
infra_host_percentage float The percentage of infrastructure host usage by tag(s). [optional]
infra_host_usage float The infrastructure host usage by tag(s). [optional]
lambda_functions_percentage float The percentage of Lambda function usage by tag(s). [optional]
lambda_functions_usage float The Lambda function usage by tag(s). [optional]
lambda_invocations_percentage float The percentage of Lambda invocation usage by tag(s). [optional]
lambda_invocations_usage float The Lambda invocation usage by tag(s). [optional]
lambda_percentage float The percentage of Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_percentage instead. [optional]
lambda_usage float The Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_usage instead. [optional]
npm_host_percentage float The percentage of network host usage by tag(s). [optional]
npm_host_usage float The network host usage by tag(s). [optional]
snmp_percentage float The percentage of network device usage by tag(s). [optional]
snmp_usage float The network device usage by tag(s). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 11, 2021
\ No newline at end of file + UsageAttributionValues - Datadog API Client for Python

UsageAttributionValues

Fields in Usage Summary by tag(s).

Properties

Name Type Description Notes
api_percentage float The percentage of synthetic API test usage by tag(s). [optional]
api_usage float The synthetic API test usage by tag(s). [optional]
apm_host_percentage float The percentage of APM host usage by tag(s). [optional]
apm_host_usage float The APM host usage by tag(s). [optional]
browser_percentage float The percentage of synthetic browser test usage by tag(s). [optional]
browser_usage float The synthetic browser test usage by tag(s). [optional]
container_percentage float The percentage of container usage by tag(s). [optional]
container_usage float The container usage by tag(s). [optional]
custom_timeseries_percentage float The percentage of custom metrics usage by tag(s). [optional]
custom_timeseries_usage float The custom metrics usage by tag(s). [optional]
infra_host_percentage float The percentage of infrastructure host usage by tag(s). [optional]
infra_host_usage float The infrastructure host usage by tag(s). [optional]
lambda_functions_percentage float The percentage of Lambda function usage by tag(s). [optional]
lambda_functions_usage float The Lambda function usage by tag(s). [optional]
lambda_invocations_percentage float The percentage of Lambda invocation usage by tag(s). [optional]
lambda_invocations_usage float The Lambda invocation usage by tag(s). [optional]
lambda_percentage float The percentage of Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_percentage instead. [optional]
lambda_usage float The Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_usage instead. [optional]
npm_host_percentage float The percentage of network host usage by tag(s). [optional]
npm_host_usage float The network host usage by tag(s). [optional]
snmp_percentage float The percentage of network device usage by tag(s). [optional]
snmp_usage float The network device usage by tag(s). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageBillableSummaryBody/index.html b/v1/UsageBillableSummaryBody/index.html index d9067dd216..f560117a23 100644 --- a/v1/UsageBillableSummaryBody/index.html +++ b/v1/UsageBillableSummaryBody/index.html @@ -1 +1 @@ - UsageBillableSummaryBody - Datadog API Client for Python

UsageBillableSummaryBody

Response with properties for each aggregated usage type.

Properties

Name Type Description Notes
account_billable_usage int The total account usage. [optional]
elapsed_usage_hours int Elapsed usage hours for some billable product. [optional]
first_billable_usage_hour datetime The first billable hour for the org. [optional]
last_billable_usage_hour datetime The last billable hour for the org. [optional]
org_billable_usage int The number of units used within the billable timeframe. [optional]
percentage_in_account float The percentage of account usage the org represents. [optional]
usage_unit str Units pertaining to the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageBillableSummaryBody - Datadog API Client for Python

UsageBillableSummaryBody

Response with properties for each aggregated usage type.

Properties

Name Type Description Notes
account_billable_usage int The total account usage. [optional]
elapsed_usage_hours int Elapsed usage hours for some billable product. [optional]
first_billable_usage_hour datetime The first billable hour for the org. [optional]
last_billable_usage_hour datetime The last billable hour for the org. [optional]
org_billable_usage int The number of units used within the billable timeframe. [optional]
percentage_in_account float The percentage of account usage the org represents. [optional]
usage_unit str Units pertaining to the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageBillableSummaryHour/index.html b/v1/UsageBillableSummaryHour/index.html index bb7c5fd933..139b406c00 100644 --- a/v1/UsageBillableSummaryHour/index.html +++ b/v1/UsageBillableSummaryHour/index.html @@ -1 +1 @@ - UsageBillableSummaryHour - Datadog API Client for Python

UsageBillableSummaryHour

Response with monthly summary of data billed by Datadog.

Properties

Name Type Description Notes
billing_plan str The billing plan. [optional]
end_date datetime Shows the last date of usage. [optional]
num_orgs int The number of organizations. [optional]
org_name str The organization name. [optional]
public_id str The organization public ID. [optional]
ratio_in_month int Shows usage aggregation for a billing period. [optional]
start_date datetime Shows the first date of usage. [optional]
usage UsageBillableSummaryKeys [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageBillableSummaryHour - Datadog API Client for Python

UsageBillableSummaryHour

Response with monthly summary of data billed by Datadog.

Properties

Name Type Description Notes
billing_plan str The billing plan. [optional]
end_date datetime Shows the last date of usage. [optional]
num_orgs int The number of organizations. [optional]
org_name str The organization name. [optional]
public_id str The organization public ID. [optional]
ratio_in_month int Shows usage aggregation for a billing period. [optional]
start_date datetime Shows the first date of usage. [optional]
usage UsageBillableSummaryKeys [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageBillableSummaryKeys/index.html b/v1/UsageBillableSummaryKeys/index.html index 7e785a9d3b..96581cdd03 100644 --- a/v1/UsageBillableSummaryKeys/index.html +++ b/v1/UsageBillableSummaryKeys/index.html @@ -1 +1 @@ - UsageBillableSummaryKeys - Datadog API Client for Python

UsageBillableSummaryKeys

Response with aggregated usage types.

Properties

Name Type Description Notes
apm_host_sum UsageBillableSummaryBody [optional]
apm_host_top99p UsageBillableSummaryBody [optional]
apm_trace_search_sum UsageBillableSummaryBody [optional]
fargate_container_average UsageBillableSummaryBody [optional]
infra_container_sum UsageBillableSummaryBody [optional]
infra_host_sum UsageBillableSummaryBody [optional]
infra_host_top99p UsageBillableSummaryBody [optional]
iot_top99p UsageBillableSummaryBody [optional]
lambda_function_average UsageBillableSummaryBody [optional]
logs_indexed_sum UsageBillableSummaryBody [optional]
logs_ingested_sum UsageBillableSummaryBody [optional]
npm_flow_sum UsageBillableSummaryBody [optional]
npm_host_top99p UsageBillableSummaryBody [optional]
rum_sum UsageBillableSummaryBody [optional]
serverless_invocation_sum UsageBillableSummaryBody [optional]
siem_sum UsageBillableSummaryBody [optional]
synthetics_api_tests_sum UsageBillableSummaryBody [optional]
synthetics_browser_checks_sum UsageBillableSummaryBody [optional]
timeseries_average UsageBillableSummaryBody [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 11, 2021
\ No newline at end of file + UsageBillableSummaryKeys - Datadog API Client for Python

UsageBillableSummaryKeys

Response with aggregated usage types.

Properties

Name Type Description Notes
apm_host_sum UsageBillableSummaryBody [optional]
apm_host_top99p UsageBillableSummaryBody [optional]
apm_trace_search_sum UsageBillableSummaryBody [optional]
fargate_container_average UsageBillableSummaryBody [optional]
infra_container_sum UsageBillableSummaryBody [optional]
infra_host_sum UsageBillableSummaryBody [optional]
infra_host_top99p UsageBillableSummaryBody [optional]
iot_top99p UsageBillableSummaryBody [optional]
lambda_function_average UsageBillableSummaryBody [optional]
logs_indexed_sum UsageBillableSummaryBody [optional]
logs_ingested_sum UsageBillableSummaryBody [optional]
npm_flow_sum UsageBillableSummaryBody [optional]
npm_host_top99p UsageBillableSummaryBody [optional]
rum_sum UsageBillableSummaryBody [optional]
serverless_invocation_sum UsageBillableSummaryBody [optional]
siem_sum UsageBillableSummaryBody [optional]
synthetics_api_tests_sum UsageBillableSummaryBody [optional]
synthetics_browser_checks_sum UsageBillableSummaryBody [optional]
timeseries_average UsageBillableSummaryBody [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageBillableSummaryResponse/index.html b/v1/UsageBillableSummaryResponse/index.html index baf2978328..b1845db8ce 100644 --- a/v1/UsageBillableSummaryResponse/index.html +++ b/v1/UsageBillableSummaryResponse/index.html @@ -1 +1 @@ - UsageBillableSummaryResponse - Datadog API Client for Python
\ No newline at end of file + UsageBillableSummaryResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageCustomReportsAttributes/index.html b/v1/UsageCustomReportsAttributes/index.html index 77da71a606..5679249375 100644 --- a/v1/UsageCustomReportsAttributes/index.html +++ b/v1/UsageCustomReportsAttributes/index.html @@ -1 +1 @@ - UsageCustomReportsAttributes - Datadog API Client for Python

UsageCustomReportsAttributes

The response containing attributes for custom reports.

Properties

Name Type Description Notes
computed_on str The date the specified custom report was computed. [optional]
end_date str The ending date of custom report. [optional]
size int size [optional]
start_date str The starting date of custom report. [optional]
tags [str] A list of tags to apply to custom reports. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageCustomReportsAttributes - Datadog API Client for Python

UsageCustomReportsAttributes

The response containing attributes for custom reports.

Properties

Name Type Description Notes
computed_on str The date the specified custom report was computed. [optional]
end_date str The ending date of custom report. [optional]
size int size [optional]
start_date str The starting date of custom report. [optional]
tags [str] A list of tags to apply to custom reports. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageCustomReportsData/index.html b/v1/UsageCustomReportsData/index.html index 8fb68f9e37..9fd73e693c 100644 --- a/v1/UsageCustomReportsData/index.html +++ b/v1/UsageCustomReportsData/index.html @@ -1 +1 @@ - UsageCustomReportsData - Datadog API Client for Python
\ No newline at end of file + UsageCustomReportsData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageCustomReportsMeta/index.html b/v1/UsageCustomReportsMeta/index.html index b07cc4453c..5bfdc86a1e 100644 --- a/v1/UsageCustomReportsMeta/index.html +++ b/v1/UsageCustomReportsMeta/index.html @@ -1 +1 @@ - UsageCustomReportsMeta - Datadog API Client for Python
\ No newline at end of file + UsageCustomReportsMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageCustomReportsPage/index.html b/v1/UsageCustomReportsPage/index.html index d7f913df09..fa4a919467 100644 --- a/v1/UsageCustomReportsPage/index.html +++ b/v1/UsageCustomReportsPage/index.html @@ -1 +1 @@ - UsageCustomReportsPage - Datadog API Client for Python
\ No newline at end of file + UsageCustomReportsPage - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageCustomReportsResponse/index.html b/v1/UsageCustomReportsResponse/index.html index 7344798249..5e0eae8863 100644 --- a/v1/UsageCustomReportsResponse/index.html +++ b/v1/UsageCustomReportsResponse/index.html @@ -1 +1 @@ - UsageCustomReportsResponse - Datadog API Client for Python
\ No newline at end of file + UsageCustomReportsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageFargateHour/index.html b/v1/UsageFargateHour/index.html index b2c20f48a6..b543f0f3e3 100644 --- a/v1/UsageFargateHour/index.html +++ b/v1/UsageFargateHour/index.html @@ -1 +1 @@ - UsageFargateHour - Datadog API Client for Python

UsageFargateHour

Number of Fargate tasks run and hourly usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
tasks_count int The number of Fargate tasks run. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageFargateHour - Datadog API Client for Python

UsageFargateHour

Number of Fargate tasks run and hourly usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
tasks_count int The number of Fargate tasks run. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageFargateResponse/index.html b/v1/UsageFargateResponse/index.html index e61ec8b842..df0c46f4bd 100644 --- a/v1/UsageFargateResponse/index.html +++ b/v1/UsageFargateResponse/index.html @@ -1 +1 @@ - UsageFargateResponse - Datadog API Client for Python
\ No newline at end of file + UsageFargateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageHostHour/index.html b/v1/UsageHostHour/index.html index 25541584cc..0209f14ef9 100644 --- a/v1/UsageHostHour/index.html +++ b/v1/UsageHostHour/index.html @@ -1 +1 @@ - UsageHostHour - Datadog API Client for Python

UsageHostHour

Number of hosts/containers recorded for each hour for a given organization.

Properties

Name Type Description Notes
agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional]
alibaba_host_count int Contains the total number of hosts that reported via Alibaba integration (and were NOT running the Datadog Agent). [optional]
apm_azure_app_service_host_count int Contains the total number of Azure App Services hosts using APM. [optional]
apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional]
aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional]
azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional]
container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional]
gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional]
host_count int Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. [optional]
hour datetime The hour for the usage. [optional]
infra_azure_app_service int Contains the total number of hosts that reported via the Azure App Services integration (and were NOT running the Datadog Agent). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 29, 2020
\ No newline at end of file + UsageHostHour - Datadog API Client for Python

UsageHostHour

Number of hosts/containers recorded for each hour for a given organization.

Properties

Name Type Description Notes
agent_host_count int Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. [optional]
alibaba_host_count int Contains the total number of hosts that reported via Alibaba integration (and were NOT running the Datadog Agent). [optional]
apm_azure_app_service_host_count int Contains the total number of Azure App Services hosts using APM. [optional]
apm_host_count int Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). [optional]
aws_host_count int Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). [optional]
azure_host_count int Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). [optional]
container_count int Shows the total number of containers reported by the Docker integration during the hour. [optional]
gcp_host_count int Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). [optional]
host_count int Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. [optional]
hour datetime The hour for the usage. [optional]
infra_azure_app_service int Contains the total number of hosts that reported via the Azure App Services integration (and were NOT running the Datadog Agent). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageHostsResponse/index.html b/v1/UsageHostsResponse/index.html index c362645a3e..61411daebe 100644 --- a/v1/UsageHostsResponse/index.html +++ b/v1/UsageHostsResponse/index.html @@ -1 +1 @@ - UsageHostsResponse - Datadog API Client for Python
\ No newline at end of file + UsageHostsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageIncidentManagementHour/index.html b/v1/UsageIncidentManagementHour/index.html index c48631d1a6..841eb064dc 100644 --- a/v1/UsageIncidentManagementHour/index.html +++ b/v1/UsageIncidentManagementHour/index.html @@ -1 +1 @@ - UsageIncidentManagementHour - Datadog API Client for Python

UsageIncidentManagementHour

Incident management usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 18, 2020
\ No newline at end of file + UsageIncidentManagementHour - Datadog API Client for Python

UsageIncidentManagementHour

Incident management usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
monthly_active_users int Contains the total number monthly active users from the start of the given hour's month until the given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageIncidentManagementResponse/index.html b/v1/UsageIncidentManagementResponse/index.html index e1b968dbe9..c63938fb59 100644 --- a/v1/UsageIncidentManagementResponse/index.html +++ b/v1/UsageIncidentManagementResponse/index.html @@ -1 +1 @@ - UsageIncidentManagementResponse - Datadog API Client for Python
\ No newline at end of file + UsageIncidentManagementResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageIndexedSpansHour/index.html b/v1/UsageIndexedSpansHour/index.html index 5c7ac34224..1d3d34168e 100644 --- a/v1/UsageIndexedSpansHour/index.html +++ b/v1/UsageIndexedSpansHour/index.html @@ -1 +1 @@ - UsageIndexedSpansHour - Datadog API Client for Python

UsageIndexedSpansHour

The hours of indexed spans usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of spans indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 11, 2020
\ No newline at end of file + UsageIndexedSpansHour - Datadog API Client for Python

UsageIndexedSpansHour

The hours of indexed spans usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of spans indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageIndexedSpansResponse/index.html b/v1/UsageIndexedSpansResponse/index.html index 4bc8478518..ec144d448f 100644 --- a/v1/UsageIndexedSpansResponse/index.html +++ b/v1/UsageIndexedSpansResponse/index.html @@ -1 +1 @@ - UsageIndexedSpansResponse - Datadog API Client for Python
\ No newline at end of file + UsageIndexedSpansResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageIngestedSpansHour/index.html b/v1/UsageIngestedSpansHour/index.html index 89a4392735..0381dc2c6e 100644 --- a/v1/UsageIngestedSpansHour/index.html +++ b/v1/UsageIngestedSpansHour/index.html @@ -1 +1 @@ - UsageIngestedSpansHour - Datadog API Client for Python

UsageIngestedSpansHour

Ingested spans usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 11, 2020
\ No newline at end of file + UsageIngestedSpansHour - Datadog API Client for Python

UsageIngestedSpansHour

Ingested spans usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageIngestedSpansResponse/index.html b/v1/UsageIngestedSpansResponse/index.html index 3dd81aba44..e8e83bc6ee 100644 --- a/v1/UsageIngestedSpansResponse/index.html +++ b/v1/UsageIngestedSpansResponse/index.html @@ -1 +1 @@ - UsageIngestedSpansResponse - Datadog API Client for Python
\ No newline at end of file + UsageIngestedSpansResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageIoTHour/index.html b/v1/UsageIoTHour/index.html index ad0ffaaa27..3336770ccb 100644 --- a/v1/UsageIoTHour/index.html +++ b/v1/UsageIoTHour/index.html @@ -1 +1 @@ - UsageIoTHour - Datadog API Client for Python

UsageIoTHour

IoT usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
iot_device_count int The total number of IoT device hours from the start of the given hour's month until the given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 29, 2021
\ No newline at end of file + UsageIoTHour - Datadog API Client for Python

UsageIoTHour

IoT usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
iot_device_count int The total number of IoT device hours from the start of the given hour's month until the given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageIoTResponse/index.html b/v1/UsageIoTResponse/index.html index 6be4dedc5c..c5a530b6a9 100644 --- a/v1/UsageIoTResponse/index.html +++ b/v1/UsageIoTResponse/index.html @@ -1 +1 @@ - UsageIoTResponse - Datadog API Client for Python
\ No newline at end of file + UsageIoTResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageLambdaHour/index.html b/v1/UsageLambdaHour/index.html index b16a244498..4f82d49585 100644 --- a/v1/UsageLambdaHour/index.html +++ b/v1/UsageLambdaHour/index.html @@ -1 +1 @@ - UsageLambdaHour - Datadog API Client for Python

UsageLambdaHour

Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.

Properties

Name Type Description Notes
func_count int Contains the number of different functions for each region and AWS account. [optional]
hour datetime The hour for the usage. [optional]
invocations_sum int Contains the sum of invocations of all functions. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageLambdaHour - Datadog API Client for Python

UsageLambdaHour

Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.

Properties

Name Type Description Notes
func_count int Contains the number of different functions for each region and AWS account. [optional]
hour datetime The hour for the usage. [optional]
invocations_sum int Contains the sum of invocations of all functions. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageLambdaResponse/index.html b/v1/UsageLambdaResponse/index.html index ce116612ec..b1ed61d1b8 100644 --- a/v1/UsageLambdaResponse/index.html +++ b/v1/UsageLambdaResponse/index.html @@ -1 +1 @@ - UsageLambdaResponse - Datadog API Client for Python
\ No newline at end of file + UsageLambdaResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageLogsByIndexHour/index.html b/v1/UsageLogsByIndexHour/index.html index 0d6cb9c50a..a664c0913a 100644 --- a/v1/UsageLogsByIndexHour/index.html +++ b/v1/UsageLogsByIndexHour/index.html @@ -1 +1 @@ - UsageLogsByIndexHour - Datadog API Client for Python

UsageLogsByIndexHour

Number of indexed logs for each hour and index for a given organization.

Properties

Name Type Description Notes
event_count int The total number of indexed logs for the queried hour. [optional]
hour datetime The hour for the usage. [optional]
index_id str The index ID for this usage. [optional]
index_name str The user specified name for this index ID. [optional]
retention int The retention period (in days) for this index ID. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageLogsByIndexHour - Datadog API Client for Python

UsageLogsByIndexHour

Number of indexed logs for each hour and index for a given organization.

Properties

Name Type Description Notes
event_count int The total number of indexed logs for the queried hour. [optional]
hour datetime The hour for the usage. [optional]
index_id str The index ID for this usage. [optional]
index_name str The user specified name for this index ID. [optional]
retention int The retention period (in days) for this index ID. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageLogsByIndexResponse/index.html b/v1/UsageLogsByIndexResponse/index.html index e79d6c2127..3ec78e9149 100644 --- a/v1/UsageLogsByIndexResponse/index.html +++ b/v1/UsageLogsByIndexResponse/index.html @@ -1 +1 @@ - UsageLogsByIndexResponse - Datadog API Client for Python
\ No newline at end of file + UsageLogsByIndexResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageLogsHour/index.html b/v1/UsageLogsHour/index.html index 8c3f35aafb..2602409865 100644 --- a/v1/UsageLogsHour/index.html +++ b/v1/UsageLogsHour/index.html @@ -1 +1 @@ - UsageLogsHour - Datadog API Client for Python

UsageLogsHour

Hour usage for logs.

Properties

Name Type Description Notes
billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional]
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of log events indexed. [optional]
ingested_events_bytes int Contains the number of log bytes ingested. [optional]
logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional]
logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional]
logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional]
logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 13, 2021
\ No newline at end of file + UsageLogsHour - Datadog API Client for Python

UsageLogsHour

Hour usage for logs.

Properties

Name Type Description Notes
billable_ingested_bytes int Contains the number of billable log bytes ingested. [optional]
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of log events indexed. [optional]
ingested_events_bytes int Contains the number of log bytes ingested. [optional]
logs_live_indexed_count int Contains the number of live log events indexed (data available as of December 1, 2020). [optional]
logs_live_ingested_bytes int Contains the number of live log bytes ingested (data available as of December 1, 2020). [optional]
logs_rehydrated_indexed_count int Contains the number of rehydrated log events indexed (data available as of December 1, 2020). [optional]
logs_rehydrated_ingested_bytes int Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageLogsResponse/index.html b/v1/UsageLogsResponse/index.html index 2239b16093..9356dc274e 100644 --- a/v1/UsageLogsResponse/index.html +++ b/v1/UsageLogsResponse/index.html @@ -1 +1 @@ - UsageLogsResponse - Datadog API Client for Python
\ No newline at end of file + UsageLogsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageMeteringApi/index.html b/v1/UsageMeteringApi/index.html index e8641f7aa0..5103749c72 100644 --- a/v1/UsageMeteringApi/index.html +++ b/v1/UsageMeteringApi/index.html @@ -1191,4 +1191,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling UsageMeteringApi->get_usage_trace: %s\n" % e) -

Parameters

Name Type Description Notes
start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.
end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]

Return type

UsageTraceResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;datetime-format=rfc3339

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden - User is not authorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
start_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.
end_hr datetime Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour. [optional]

Return type

UsageTraceResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;datetime-format=rfc3339

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden - User is not authorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageMetricCategory/index.html b/v1/UsageMetricCategory/index.html index bccbe232f1..e55cbe0eb5 100644 --- a/v1/UsageMetricCategory/index.html +++ b/v1/UsageMetricCategory/index.html @@ -1 +1 @@ - UsageMetricCategory - Datadog API Client for Python
\ No newline at end of file + UsageMetricCategory - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageNetworkFlowsHour/index.html b/v1/UsageNetworkFlowsHour/index.html index 2138dba417..ef040c0cad 100644 --- a/v1/UsageNetworkFlowsHour/index.html +++ b/v1/UsageNetworkFlowsHour/index.html @@ -1 +1 @@ - UsageNetworkFlowsHour - Datadog API Client for Python

UsageNetworkFlowsHour

Number of netflow events indexed for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_event_count int Contains the number of netflow events indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageNetworkFlowsHour - Datadog API Client for Python

UsageNetworkFlowsHour

Number of netflow events indexed for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_event_count int Contains the number of netflow events indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageNetworkFlowsResponse/index.html b/v1/UsageNetworkFlowsResponse/index.html index 835cd85462..653ef283f7 100644 --- a/v1/UsageNetworkFlowsResponse/index.html +++ b/v1/UsageNetworkFlowsResponse/index.html @@ -1 +1 @@ - UsageNetworkFlowsResponse - Datadog API Client for Python
\ No newline at end of file + UsageNetworkFlowsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageNetworkHostsHour/index.html b/v1/UsageNetworkHostsHour/index.html index cb8f4be8d1..6a04cce0e9 100644 --- a/v1/UsageNetworkHostsHour/index.html +++ b/v1/UsageNetworkHostsHour/index.html @@ -1 +1 @@ - UsageNetworkHostsHour - Datadog API Client for Python

UsageNetworkHostsHour

Number of active NPM hosts for each hour for a given organization.

Properties

Name Type Description Notes
host_count int Contains the number of active NPM hosts. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageNetworkHostsHour - Datadog API Client for Python

UsageNetworkHostsHour

Number of active NPM hosts for each hour for a given organization.

Properties

Name Type Description Notes
host_count int Contains the number of active NPM hosts. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageNetworkHostsResponse/index.html b/v1/UsageNetworkHostsResponse/index.html index dff725bfaf..4327e70f2a 100644 --- a/v1/UsageNetworkHostsResponse/index.html +++ b/v1/UsageNetworkHostsResponse/index.html @@ -1 +1 @@ - UsageNetworkHostsResponse - Datadog API Client for Python
\ No newline at end of file + UsageNetworkHostsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageProfilingHour/index.html b/v1/UsageProfilingHour/index.html index 508fee6191..2ef19ea101 100644 --- a/v1/UsageProfilingHour/index.html +++ b/v1/UsageProfilingHour/index.html @@ -1 +1 @@ - UsageProfilingHour - Datadog API Client for Python

UsageProfilingHour

The number of profiled hosts for each hour for a given organization.

Properties

Name Type Description Notes
avg_container_agent_count int Get average number of container agents for that hour. [optional]
host_count int Contains the total number of profiled hosts reporting during a given hour. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageProfilingHour - Datadog API Client for Python

UsageProfilingHour

The number of profiled hosts for each hour for a given organization.

Properties

Name Type Description Notes
avg_container_agent_count int Get average number of container agents for that hour. [optional]
host_count int Contains the total number of profiled hosts reporting during a given hour. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageProfilingResponse/index.html b/v1/UsageProfilingResponse/index.html index 8092935082..2d3f3214e5 100644 --- a/v1/UsageProfilingResponse/index.html +++ b/v1/UsageProfilingResponse/index.html @@ -1 +1 @@ - UsageProfilingResponse - Datadog API Client for Python
\ No newline at end of file + UsageProfilingResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageReportsType/index.html b/v1/UsageReportsType/index.html index 6a382631de..101798ea12 100644 --- a/v1/UsageReportsType/index.html +++ b/v1/UsageReportsType/index.html @@ -1 +1 @@ - UsageReportsType - Datadog API Client for Python
\ No newline at end of file + UsageReportsType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageRumSessionsHour/index.html b/v1/UsageRumSessionsHour/index.html index da475acdff..394ce53d5d 100644 --- a/v1/UsageRumSessionsHour/index.html +++ b/v1/UsageRumSessionsHour/index.html @@ -1 +1 @@ - UsageRumSessionsHour - Datadog API Client for Python

UsageRumSessionsHour

Number of RUM Sessions recorded for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
session_count int Contains the number of RUM Sessions. [optional]
session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional]
session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 28, 2020
\ No newline at end of file + UsageRumSessionsHour - Datadog API Client for Python

UsageRumSessionsHour

Number of RUM Sessions recorded for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
session_count int Contains the number of RUM Sessions. [optional]
session_count_android int Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). [optional]
session_count_ios int Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageRumSessionsResponse/index.html b/v1/UsageRumSessionsResponse/index.html index 22598a7823..b6e79cd0b4 100644 --- a/v1/UsageRumSessionsResponse/index.html +++ b/v1/UsageRumSessionsResponse/index.html @@ -1 +1 @@ - UsageRumSessionsResponse - Datadog API Client for Python
\ No newline at end of file + UsageRumSessionsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSNMPHour/index.html b/v1/UsageSNMPHour/index.html index b99b6dee32..c78cb998aa 100644 --- a/v1/UsageSNMPHour/index.html +++ b/v1/UsageSNMPHour/index.html @@ -1 +1 @@ - UsageSNMPHour - Datadog API Client for Python

UsageSNMPHour

The number of SNMP devices for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
snmp_devices int Contains the number of SNMP devices. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageSNMPHour - Datadog API Client for Python

UsageSNMPHour

The number of SNMP devices for each hour for a given organization.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
snmp_devices int Contains the number of SNMP devices. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSNMPResponse/index.html b/v1/UsageSNMPResponse/index.html index 0d579425d3..f3dddea76e 100644 --- a/v1/UsageSNMPResponse/index.html +++ b/v1/UsageSNMPResponse/index.html @@ -1 +1 @@ - UsageSNMPResponse - Datadog API Client for Python
\ No newline at end of file + UsageSNMPResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSort/index.html b/v1/UsageSort/index.html index 14159384f0..29c62ebc03 100644 --- a/v1/UsageSort/index.html +++ b/v1/UsageSort/index.html @@ -1 +1 @@ - UsageSort - Datadog API Client for Python

UsageSort

The field to sort by.

Properties

Name Type Description Notes
value str The field to sort by. defaults to "start_date", must be one of ["computed_on", "size", "start_date", "end_date", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + UsageSort - Datadog API Client for Python

UsageSort

The field to sort by.

Properties

Name Type Description Notes
value str The field to sort by. defaults to "start_date", must be one of ["computed_on", "size", "start_date", "end_date", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSortDirection/index.html b/v1/UsageSortDirection/index.html index 37f8d36ad8..e4e521317a 100644 --- a/v1/UsageSortDirection/index.html +++ b/v1/UsageSortDirection/index.html @@ -1 +1 @@ - UsageSortDirection - Datadog API Client for Python
\ No newline at end of file + UsageSortDirection - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSpecifiedCustomReportsAttributes/index.html b/v1/UsageSpecifiedCustomReportsAttributes/index.html index 83fb631ac4..c5063e8597 100644 --- a/v1/UsageSpecifiedCustomReportsAttributes/index.html +++ b/v1/UsageSpecifiedCustomReportsAttributes/index.html @@ -1 +1 @@ - UsageSpecifiedCustomReportsAttributes - Datadog API Client for Python

UsageSpecifiedCustomReportsAttributes

The response containing attributes for specified custom reports.

Properties

Name Type Description Notes
computed_on str The date the specified custom report was computed. [optional]
end_date str The ending date of specified custom report. [optional]
location str A downloadable file for the specified custom reporting file. [optional]
size int size [optional]
start_date str The starting date of specified custom report. [optional]
tags [str] A list of tags to apply to specified custom reports. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageSpecifiedCustomReportsAttributes - Datadog API Client for Python

UsageSpecifiedCustomReportsAttributes

The response containing attributes for specified custom reports.

Properties

Name Type Description Notes
computed_on str The date the specified custom report was computed. [optional]
end_date str The ending date of specified custom report. [optional]
location str A downloadable file for the specified custom reporting file. [optional]
size int size [optional]
start_date str The starting date of specified custom report. [optional]
tags [str] A list of tags to apply to specified custom reports. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSpecifiedCustomReportsData/index.html b/v1/UsageSpecifiedCustomReportsData/index.html index f4dd3392ed..5b0c80ffa6 100644 --- a/v1/UsageSpecifiedCustomReportsData/index.html +++ b/v1/UsageSpecifiedCustomReportsData/index.html @@ -1 +1 @@ - UsageSpecifiedCustomReportsData - Datadog API Client for Python
\ No newline at end of file + UsageSpecifiedCustomReportsData - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSpecifiedCustomReportsMeta/index.html b/v1/UsageSpecifiedCustomReportsMeta/index.html index 528faffd9f..8448286520 100644 --- a/v1/UsageSpecifiedCustomReportsMeta/index.html +++ b/v1/UsageSpecifiedCustomReportsMeta/index.html @@ -1 +1 @@ - UsageSpecifiedCustomReportsMeta - Datadog API Client for Python
\ No newline at end of file + UsageSpecifiedCustomReportsMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSpecifiedCustomReportsPage/index.html b/v1/UsageSpecifiedCustomReportsPage/index.html index f7a0acf957..bcfb7d9657 100644 --- a/v1/UsageSpecifiedCustomReportsPage/index.html +++ b/v1/UsageSpecifiedCustomReportsPage/index.html @@ -1 +1 @@ - UsageSpecifiedCustomReportsPage - Datadog API Client for Python
\ No newline at end of file + UsageSpecifiedCustomReportsPage - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSpecifiedCustomReportsResponse/index.html b/v1/UsageSpecifiedCustomReportsResponse/index.html index 8f9fab8e1e..0287403f7a 100644 --- a/v1/UsageSpecifiedCustomReportsResponse/index.html +++ b/v1/UsageSpecifiedCustomReportsResponse/index.html @@ -1 +1 @@ - UsageSpecifiedCustomReportsResponse - Datadog API Client for Python
\ No newline at end of file + UsageSpecifiedCustomReportsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSummaryDate/index.html b/v1/UsageSummaryDate/index.html index 8dc9075614..6784ea03da 100644 --- a/v1/UsageSummaryDate/index.html +++ b/v1/UsageSummaryDate/index.html @@ -1 +1 @@ - UsageSummaryDate - Datadog API Client for Python

UsageSummaryDate

Response with hourly report of all data billed by Datadog all organizations.

Properties

Name Type Description Notes
agent_host_top99p int Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. [optional]
apm_azure_app_service_host_top99p int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional]
apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional]
aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional]
aws_lambda_func_count int Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional]
azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional]
billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional]
container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional]
container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional]
custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional]
date datetime The date for the usage. [optional]
fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional]
fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional]
gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional]
incident_management_monthly_active_users_hwm int Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. [optional]
indexed_events_count_sum int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional]
infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional]
ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional]
mobile_rum_session_count_android_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for all organizations. [optional]
mobile_rum_session_count_ios_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for all organizations. [optional]
mobile_rum_session_count_sum int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional]
netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional]
npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional]
orgs [UsageSummaryDateOrg] Organizations associated with a user. [optional]
profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional]
rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional]
rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional]
synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional]
synthetics_check_calls_count_sum int Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. [optional]
trace_search_indexed_events_count_sum int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional]
twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 29, 2021
\ No newline at end of file + UsageSummaryDate - Datadog API Client for Python

UsageSummaryDate

Response with hourly report of all data billed by Datadog all organizations.

Properties

Name Type Description Notes
agent_host_top99p int Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. [optional]
apm_azure_app_service_host_top99p int Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. [optional]
apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. [optional]
aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. [optional]
aws_lambda_func_count int Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. [optional]
azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. [optional]
billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional]
container_avg int Shows the average of all distinct containers over all hours in the current date for all organizations. [optional]
container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. [optional]
custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for all organizations. [optional]
date datetime The date for the usage. [optional]
fargate_tasks_count_avg int Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. [optional]
fargate_tasks_count_hwm int Shows the average of all Fargate tasks over all hours in the current date for all organizations. [optional]
gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. [optional]
incident_management_monthly_active_users_hwm int Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. [optional]
indexed_events_count_sum int Shows the sum of all log events indexed over all hours in the current date for all organizations. [optional]
infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. [optional]
ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for all organizations. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for all organizations. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. [optional]
mobile_rum_session_count_android_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for all organizations. [optional]
mobile_rum_session_count_ios_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for all organizations. [optional]
mobile_rum_session_count_sum int Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations [optional]
netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for all organizations. [optional]
npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. [optional]
orgs [UsageSummaryDateOrg] Organizations associated with a user. [optional]
profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. [optional]
rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations [optional]
rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. [optional]
synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. [optional]
synthetics_check_calls_count_sum int Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. [optional]
trace_search_indexed_events_count_sum int Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. [optional]
twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSummaryDateOrg/index.html b/v1/UsageSummaryDateOrg/index.html index abe6436f60..cfcb5cf0f2 100644 --- a/v1/UsageSummaryDateOrg/index.html +++ b/v1/UsageSummaryDateOrg/index.html @@ -1 +1 @@ - UsageSummaryDateOrg - Datadog API Client for Python

UsageSummaryDateOrg

Global hourly report of all data billed by Datadog for a given organization.

Properties

Name Type Description Notes
agent_host_top99p int Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. [optional]
apm_azure_app_service_host_top99p int Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. [optional]
apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional]
aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional]
aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional]
azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. [optional]
billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional]
container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional]
container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional]
custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional]
fargate_tasks_count_avg int The average task count for Fargate. [optional]
fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional]
gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional]
id str The organization id. [optional]
incident_management_monthly_active_users_hwm int Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. [optional]
indexed_events_count_sum int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional]
infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. [optional]
ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. [optional]
mobile_rum_session_count_android_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for the given org. [optional]
mobile_rum_session_count_ios_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for the given org. [optional]
mobile_rum_session_count_sum int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional]
name str The organization name. [optional]
netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional]
npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional]
profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional]
public_id str The organization public id. [optional]
rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for the given org. [optional]
rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional]
synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. [optional]
synthetics_check_calls_count_sum int Shows the sum of all Synthetic API tests over all hours in the current date for the given org. [optional]
trace_search_indexed_events_count_sum int Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. [optional]
twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for the given org. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 29, 2021
\ No newline at end of file + UsageSummaryDateOrg - Datadog API Client for Python

UsageSummaryDateOrg

Global hourly report of all data billed by Datadog for a given organization.

Properties

Name Type Description Notes
agent_host_top99p int Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. [optional]
apm_azure_app_service_host_top99p int Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. [optional]
apm_host_top99p int Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. [optional]
aws_host_top99p int Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. [optional]
aws_lambda_func_count int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. [optional]
azure_app_service_top99p int Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. [optional]
billable_ingested_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional]
container_avg int Shows the average of all distinct containers over all hours in the current date for the given org. [optional]
container_hwm int Shows the high-water mark of all distinct containers over all hours in the current date for the given org. [optional]
custom_ts_avg int Shows the average number of distinct custom metrics over all hours in the current date for the given org. [optional]
fargate_tasks_count_avg int The average task count for Fargate. [optional]
fargate_tasks_count_hwm int Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. [optional]
gcp_host_top99p int Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. [optional]
id str The organization id. [optional]
incident_management_monthly_active_users_hwm int Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. [optional]
indexed_events_count_sum int Shows the sum of all log events indexed over all hours in the current date for the given org. [optional]
infra_host_top99p int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. [optional]
ingested_events_bytes_sum int Shows the sum of all log bytes ingested over all hours in the current date for the given org. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current date for the given org. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. [optional]
mobile_rum_session_count_android_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for the given org. [optional]
mobile_rum_session_count_ios_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for the given org. [optional]
mobile_rum_session_count_sum int Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. [optional]
name str The organization name. [optional]
netflow_indexed_events_count_sum int Shows the sum of all Network flows indexed over all hours in the current date for the given org. [optional]
npm_host_top99p int Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. [optional]
profiling_host_top99p int Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. [optional]
public_id str The organization public id. [optional]
rum_session_count_sum int Shows the sum of all browser RUM Sessions over all hours in the current date for the given org. [optional]
rum_total_session_count_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. [optional]
synthetics_browser_check_calls_count_sum int Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. [optional]
synthetics_check_calls_count_sum int Shows the sum of all Synthetic API tests over all hours in the current date for the given org. [optional]
trace_search_indexed_events_count_sum int Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. [optional]
twol_ingested_events_bytes_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current date for the given org. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSummaryResponse/index.html b/v1/UsageSummaryResponse/index.html index 1e065f678f..a107c585a3 100644 --- a/v1/UsageSummaryResponse/index.html +++ b/v1/UsageSummaryResponse/index.html @@ -1 +1 @@ - UsageSummaryResponse - Datadog API Client for Python

UsageSummaryResponse

Response with hourly report of all data billed by Datadog all organizations.

Properties

Name Type Description Notes
agent_host_top99p_sum int Shows the 99th percentile of all agent hosts over all hours in the current months for all organizations. [optional]
apm_azure_app_service_host_top99p_sum int Shows the 99th percentile of all Azure app services using APM over all hours in the current months all organizations. [optional]
apm_host_top99p_sum int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional]
aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional]
aws_lambda_func_count int Shows the average of the number of functions that executed 1 or more times each hour in the current months for all organizations. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional]
azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional]
azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional]
billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional]
container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional]
container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional]
custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional]
end_date datetime Shows the last date of usage in the current months for all organizations. [optional]
fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional]
fargate_tasks_count_hwm_sum int Shows the sum of the high-water marks of all Fargate tasks over all hours in the current months for all organizations. [optional]
gcp_host_top99p_sum int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional]
incident_management_monthly_active_users_hwm_sum int Shows sum of the the high-water marks of incident management monthly active users in the current months for all organizations. [optional]
indexed_events_count_agg_sum int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional]
infra_host_top99p_sum int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current months for all organizations. [optional]
ingested_events_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional]
last_updated datetime Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional]
live_indexed_events_agg_sum int Shows the sum of all live logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
live_ingested_bytes_agg_sum int Shows the sum of all live logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
mobile_rum_session_count_agg_sum int Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations. [optional]
mobile_rum_session_count_android_agg_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations. [optional]
mobile_rum_session_count_ios_agg_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations. [optional]
netflow_indexed_events_count_agg_sum int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional]
npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional]
profiling_container_agent_count_avg int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional]
profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional]
rehydrated_indexed_events_agg_sum int Shows the sum of all rehydrated logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
rehydrated_ingested_bytes_agg_sum int Shows the sum of all rehydrated logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
rum_session_count_agg_sum int Shows the sum of all browser RUM Sessions over all hours in the current months for all organizations. [optional]
rum_total_session_count_agg_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional]
start_date datetime Shows the first date of usage in the current months for all organizations. [optional]
synthetics_browser_check_calls_count_agg_sum int Shows the sum of all Synthetic browser tests over all hours in the current months for all organizations. [optional]
synthetics_check_calls_count_agg_sum int Shows the sum of all Synthetic API tests over all hours in the current months for all organizations. [optional]
trace_search_indexed_events_count_agg_sum int Shows the sum of all Indexed Spans indexed over all hours in the current months for all organizations. [optional]
twol_ingested_events_bytes_agg_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional]
usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 29, 2021
\ No newline at end of file + UsageSummaryResponse - Datadog API Client for Python

UsageSummaryResponse

Response with hourly report of all data billed by Datadog all organizations.

Properties

Name Type Description Notes
agent_host_top99p_sum int Shows the 99th percentile of all agent hosts over all hours in the current months for all organizations. [optional]
apm_azure_app_service_host_top99p_sum int Shows the 99th percentile of all Azure app services using APM over all hours in the current months all organizations. [optional]
apm_host_top99p_sum int Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. [optional]
aws_host_top99p_sum int Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. [optional]
aws_lambda_func_count int Shows the average of the number of functions that executed 1 or more times each hour in the current months for all organizations. [optional]
aws_lambda_invocations_sum int Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. [optional]
azure_app_service_top99p_sum int Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. [optional]
azure_host_top99p_sum int Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. [optional]
billable_ingested_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional]
container_avg_sum int Shows the average of all distinct containers over all hours in the current months for all organizations. [optional]
container_hwm_sum int Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. [optional]
custom_ts_sum int Shows the average number of distinct custom metrics over all hours in the current months for all organizations. [optional]
end_date datetime Shows the last date of usage in the current months for all organizations. [optional]
fargate_tasks_count_avg_sum int Shows the average of all Fargate tasks over all hours in the current months for all organizations. [optional]
fargate_tasks_count_hwm_sum int Shows the sum of the high-water marks of all Fargate tasks over all hours in the current months for all organizations. [optional]
gcp_host_top99p_sum int Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. [optional]
incident_management_monthly_active_users_hwm_sum int Shows sum of the the high-water marks of incident management monthly active users in the current months for all organizations. [optional]
indexed_events_count_agg_sum int Shows the sum of all log events indexed over all hours in the current months for all organizations. [optional]
infra_host_top99p_sum int Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current months for all organizations. [optional]
ingested_events_bytes_agg_sum int Shows the sum of all log bytes ingested over all hours in the current months for all organizations. [optional]
iot_device_agg_sum int Shows the sum of all IoT devices over all hours in the current months for all organizations. [optional]
iot_device_top99p_sum int Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. [optional]
last_updated datetime Shows the the most recent hour in the current months for all organizations for which all usages were calculated. [optional]
live_indexed_events_agg_sum int Shows the sum of all live logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
live_ingested_bytes_agg_sum int Shows the sum of all live logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
mobile_rum_session_count_agg_sum int Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations. [optional]
mobile_rum_session_count_android_agg_sum int Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations. [optional]
mobile_rum_session_count_ios_agg_sum int Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations. [optional]
netflow_indexed_events_count_agg_sum int Shows the sum of all Network flows indexed over all hours in the current months for all organizations. [optional]
npm_host_top99p_sum int Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. [optional]
profiling_container_agent_count_avg int Shows the average number of profiled containers over all hours in the current months for all organizations. [optional]
profiling_host_count_top99p_sum int Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. [optional]
rehydrated_indexed_events_agg_sum int Shows the sum of all rehydrated logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
rehydrated_ingested_bytes_agg_sum int Shows the sum of all rehydrated logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). [optional]
rum_session_count_agg_sum int Shows the sum of all browser RUM Sessions over all hours in the current months for all organizations. [optional]
rum_total_session_count_agg_sum int Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. [optional]
start_date datetime Shows the first date of usage in the current months for all organizations. [optional]
synthetics_browser_check_calls_count_agg_sum int Shows the sum of all Synthetic browser tests over all hours in the current months for all organizations. [optional]
synthetics_check_calls_count_agg_sum int Shows the sum of all Synthetic API tests over all hours in the current months for all organizations. [optional]
trace_search_indexed_events_count_agg_sum int Shows the sum of all Indexed Spans indexed over all hours in the current months for all organizations. [optional]
twol_ingested_events_bytes_agg_sum int Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. [optional]
usage [UsageSummaryDate] An array of objects regarding hourly usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSyntheticsAPIHour/index.html b/v1/UsageSyntheticsAPIHour/index.html index de995dd334..11484fe09e 100644 --- a/v1/UsageSyntheticsAPIHour/index.html +++ b/v1/UsageSyntheticsAPIHour/index.html @@ -1 +1 @@ - UsageSyntheticsAPIHour - Datadog API Client for Python

UsageSyntheticsAPIHour

Number of Synthetics API tests run for each hour for a given organization.

Properties

Name Type Description Notes
check_calls_count int Contains the number of Synthetics API tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageSyntheticsAPIHour - Datadog API Client for Python

UsageSyntheticsAPIHour

Number of Synthetics API tests run for each hour for a given organization.

Properties

Name Type Description Notes
check_calls_count int Contains the number of Synthetics API tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSyntheticsAPIResponse/index.html b/v1/UsageSyntheticsAPIResponse/index.html index 6746d76545..34f489c489 100644 --- a/v1/UsageSyntheticsAPIResponse/index.html +++ b/v1/UsageSyntheticsAPIResponse/index.html @@ -1 +1 @@ - UsageSyntheticsAPIResponse - Datadog API Client for Python
\ No newline at end of file + UsageSyntheticsAPIResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSyntheticsBrowserHour/index.html b/v1/UsageSyntheticsBrowserHour/index.html index cd64167434..d860ec87fd 100644 --- a/v1/UsageSyntheticsBrowserHour/index.html +++ b/v1/UsageSyntheticsBrowserHour/index.html @@ -1 +1 @@ - UsageSyntheticsBrowserHour - Datadog API Client for Python

UsageSyntheticsBrowserHour

Number of Synthetics Browser tests run for each hour for a given organization.

Properties

Name Type Description Notes
browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageSyntheticsBrowserHour - Datadog API Client for Python

UsageSyntheticsBrowserHour

Number of Synthetics Browser tests run for each hour for a given organization.

Properties

Name Type Description Notes
browser_check_calls_count int Contains the number of Synthetics Browser tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSyntheticsBrowserResponse/index.html b/v1/UsageSyntheticsBrowserResponse/index.html index d7f5dce627..7b630f6d61 100644 --- a/v1/UsageSyntheticsBrowserResponse/index.html +++ b/v1/UsageSyntheticsBrowserResponse/index.html @@ -1 +1 @@ - UsageSyntheticsBrowserResponse - Datadog API Client for Python
\ No newline at end of file + UsageSyntheticsBrowserResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageSyntheticsHour/index.html b/v1/UsageSyntheticsHour/index.html index 76c3033778..aa055c3133 100644 --- a/v1/UsageSyntheticsHour/index.html +++ b/v1/UsageSyntheticsHour/index.html @@ -1 +1 @@ - UsageSyntheticsHour - Datadog API Client for Python

UsageSyntheticsHour

The number of synthetics tests run for each hour for a given organization.

Properties

Name Type Description Notes
check_calls_count int Contains the number of Synthetics API tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageSyntheticsHour - Datadog API Client for Python

UsageSyntheticsHour

The number of synthetics tests run for each hour for a given organization.

Properties

Name Type Description Notes
check_calls_count int Contains the number of Synthetics API tests run. [optional]
hour datetime The hour for the usage. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageSyntheticsResponse/index.html b/v1/UsageSyntheticsResponse/index.html index 462f23de1b..bf3efdbda1 100644 --- a/v1/UsageSyntheticsResponse/index.html +++ b/v1/UsageSyntheticsResponse/index.html @@ -1 +1 @@ - UsageSyntheticsResponse - Datadog API Client for Python
\ No newline at end of file + UsageSyntheticsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageTimeseriesHour/index.html b/v1/UsageTimeseriesHour/index.html index b11e07fac7..85ab986adb 100644 --- a/v1/UsageTimeseriesHour/index.html +++ b/v1/UsageTimeseriesHour/index.html @@ -1 +1 @@ - UsageTimeseriesHour - Datadog API Client for Python

UsageTimeseriesHour

The hourly usage of timeseries.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional]
num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional]
num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageTimeseriesHour - Datadog API Client for Python

UsageTimeseriesHour

The hourly usage of timeseries.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
num_custom_input_timeseries int Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). [optional]
num_custom_output_timeseries int Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). [optional]
num_custom_timeseries int Contains the number of non-aggregation custom metrics. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageTimeseriesResponse/index.html b/v1/UsageTimeseriesResponse/index.html index 40a9aef441..6528db3140 100644 --- a/v1/UsageTimeseriesResponse/index.html +++ b/v1/UsageTimeseriesResponse/index.html @@ -1 +1 @@ - UsageTimeseriesResponse - Datadog API Client for Python
\ No newline at end of file + UsageTimeseriesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageTopAvgMetricsHour/index.html b/v1/UsageTopAvgMetricsHour/index.html index 5c3983fb3f..2599bb3841 100644 --- a/v1/UsageTopAvgMetricsHour/index.html +++ b/v1/UsageTopAvgMetricsHour/index.html @@ -1 +1 @@ - UsageTopAvgMetricsHour - Datadog API Client for Python

UsageTopAvgMetricsHour

Number of hourly recorded custom metrics for a given organization.

Properties

Name Type Description Notes
avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional]
max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional]
metric_category UsageMetricCategory [optional]
metric_name str Contains the custom metric name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageTopAvgMetricsHour - Datadog API Client for Python

UsageTopAvgMetricsHour

Number of hourly recorded custom metrics for a given organization.

Properties

Name Type Description Notes
avg_metric_hour int Average number of timeseries per hour in which the metric occurs. [optional]
max_metric_hour int Maximum number of timeseries per hour in which the metric occurs. [optional]
metric_category UsageMetricCategory [optional]
metric_name str Contains the custom metric name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageTopAvgMetricsResponse/index.html b/v1/UsageTopAvgMetricsResponse/index.html index b7c533f05d..5b405835fe 100644 --- a/v1/UsageTopAvgMetricsResponse/index.html +++ b/v1/UsageTopAvgMetricsResponse/index.html @@ -1 +1 @@ - UsageTopAvgMetricsResponse - Datadog API Client for Python
\ No newline at end of file + UsageTopAvgMetricsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageTraceHour/index.html b/v1/UsageTraceHour/index.html index 8181bc797c..a2285a049d 100644 --- a/v1/UsageTraceHour/index.html +++ b/v1/UsageTraceHour/index.html @@ -1 +1 @@ - UsageTraceHour - Datadog API Client for Python

UsageTraceHour

The hours of trace usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of Indexed Spans indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 21, 2020
\ No newline at end of file + UsageTraceHour - Datadog API Client for Python

UsageTraceHour

The hours of trace usage.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
indexed_events_count int Contains the number of Indexed Spans indexed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageTraceResponse/index.html b/v1/UsageTraceResponse/index.html index 366ecff9e9..8c855d246e 100644 --- a/v1/UsageTraceResponse/index.html +++ b/v1/UsageTraceResponse/index.html @@ -1 +1 @@ - UsageTraceResponse - Datadog API Client for Python
\ No newline at end of file + UsageTraceResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsageTracingWithoutLimitsHour/index.html b/v1/UsageTracingWithoutLimitsHour/index.html index c86e9e1729..a33bcb9f7e 100644 --- a/v1/UsageTracingWithoutLimitsHour/index.html +++ b/v1/UsageTracingWithoutLimitsHour/index.html @@ -1 +1 @@ - UsageTracingWithoutLimitsHour - Datadog API Client for Python

UsageTracingWithoutLimitsHour

Tracing without limits usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UsageTracingWithoutLimitsHour - Datadog API Client for Python

UsageTracingWithoutLimitsHour

Tracing without limits usage for a given organization for a given hour.

Properties

Name Type Description Notes
hour datetime The hour for the usage. [optional]
ingested_events_bytes int Contains the total number of bytes ingested during a given hour. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UsageTracingWithoutLimitsResponse/index.html b/v1/UsageTracingWithoutLimitsResponse/index.html index bbcce5cac7..0ea36227f3 100644 --- a/v1/UsageTracingWithoutLimitsResponse/index.html +++ b/v1/UsageTracingWithoutLimitsResponse/index.html @@ -1 +1 @@ - UsageTracingWithoutLimitsResponse - Datadog API Client for Python
\ No newline at end of file + UsageTracingWithoutLimitsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/User/index.html b/v1/User/index.html index 6ba426efd9..0275ada372 100644 --- a/v1/User/index.html +++ b/v1/User/index.html @@ -1 +1 @@ - User - Datadog API Client for Python

User

Create, edit, and disable users.

Properties

Name Type Description Notes
access_role AccessRole [optional]
disabled bool The new disabled status of the user. [optional]
email str The new email of the user. [optional]
handle str The user handle, must be a valid email. [optional]
icon str Gravatar icon associated to the user. [optional][readonly]
name str The name of the user. [optional]
verified bool Whether or not the user logged in Datadog at least once. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + User - Datadog API Client for Python

User

Create, edit, and disable users.

Properties

Name Type Description Notes
access_role AccessRole [optional]
disabled bool The new disabled status of the user. [optional]
email str The new email of the user. [optional]
handle str The user handle, must be a valid email. [optional]
icon str Gravatar icon associated to the user. [optional][readonly]
name str The name of the user. [optional]
verified bool Whether or not the user logged in Datadog at least once. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UserDisableResponse/index.html b/v1/UserDisableResponse/index.html index 9ac10596d6..ce522abffa 100644 --- a/v1/UserDisableResponse/index.html +++ b/v1/UserDisableResponse/index.html @@ -1 +1 @@ - UserDisableResponse - Datadog API Client for Python

UserDisableResponse

Array of user disabled for a given organization.

Properties

Name Type Description Notes
message str Information pertaining to a user disabled for a given organization. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UserDisableResponse - Datadog API Client for Python

UserDisableResponse

Array of user disabled for a given organization.

Properties

Name Type Description Notes
message str Information pertaining to a user disabled for a given organization. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/UserListResponse/index.html b/v1/UserListResponse/index.html index 4637e7825e..946a8778e0 100644 --- a/v1/UserListResponse/index.html +++ b/v1/UserListResponse/index.html @@ -1 +1 @@ - UserListResponse - Datadog API Client for Python
\ No newline at end of file + UserListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UserResponse/index.html b/v1/UserResponse/index.html index cba9e3f81b..20617eeb78 100644 --- a/v1/UserResponse/index.html +++ b/v1/UserResponse/index.html @@ -1 +1 @@ - UserResponse - Datadog API Client for Python
\ No newline at end of file + UserResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/UsersApi/index.html b/v1/UsersApi/index.html index cd5f115fdb..3e68cb735e 100644 --- a/v1/UsersApi/index.html +++ b/v1/UsersApi/index.html @@ -174,4 +174,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->update_user: %s\n" % e) -

Parameters

Name Type Description Notes
user_handle str The ID of the user.
body User Description of the update.

Return type

UserResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 User updated -
400 Bad Request -
403 Authentication error -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
user_handle str The ID of the user.
body User Description of the update.

Return type

UserResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 User updated -
400 Bad Request -
403 Authentication error -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/Widget/index.html b/v1/Widget/index.html index 655c6a2d2a..fb86a7823f 100644 --- a/v1/Widget/index.html +++ b/v1/Widget/index.html @@ -1 +1 @@ - Widget - Datadog API Client for Python
\ No newline at end of file + Widget - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetAggregator/index.html b/v1/WidgetAggregator/index.html index 52d4ed988e..2bf1359a04 100644 --- a/v1/WidgetAggregator/index.html +++ b/v1/WidgetAggregator/index.html @@ -1 +1 @@ - WidgetAggregator - Datadog API Client for Python

WidgetAggregator

Aggregator used for the request.

Properties

Name Type Description Notes
value str Aggregator used for the request. must be one of ["avg", "last", "max", "min", "sum", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetAggregator - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetAxis/index.html b/v1/WidgetAxis/index.html index 140ad4d2b8..060732c37f 100644 --- a/v1/WidgetAxis/index.html +++ b/v1/WidgetAxis/index.html @@ -1 +1 @@ - WidgetAxis - Datadog API Client for Python

WidgetAxis

Axis controls for the widget.

Properties

Name Type Description Notes
include_zero bool True includes zero. [optional]
label str The label of the axis to display on the graph. [optional]
max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of "auto"
min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of "auto"
scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of "linear"

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetAxis - Datadog API Client for Python

WidgetAxis

Axis controls for the widget.

Properties

Name Type Description Notes
include_zero bool True includes zero. [optional]
label str The label of the axis to display on the graph. [optional]
max str Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of "auto"
min str Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. [optional] if omitted the server will use the default value of "auto"
scale str Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). [optional] if omitted the server will use the default value of "linear"

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetChangeType/index.html b/v1/WidgetChangeType/index.html index 97ee419f1d..53f5ab01e0 100644 --- a/v1/WidgetChangeType/index.html +++ b/v1/WidgetChangeType/index.html @@ -1 +1 @@ - WidgetChangeType - Datadog API Client for Python

WidgetChangeType

Show the absolute or the relative change.

Properties

Name Type Description Notes
value str Show the absolute or the relative change. must be one of ["absolute", "relative", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetChangeType - Datadog API Client for Python

WidgetChangeType

Show the absolute or the relative change.

Properties

Name Type Description Notes
value str Show the absolute or the relative change. must be one of ["absolute", "relative", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetColorPreference/index.html b/v1/WidgetColorPreference/index.html index 5eb6ea4d4b..1167cd18ee 100644 --- a/v1/WidgetColorPreference/index.html +++ b/v1/WidgetColorPreference/index.html @@ -1 +1 @@ - WidgetColorPreference - Datadog API Client for Python
\ No newline at end of file + WidgetColorPreference - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetComparator/index.html b/v1/WidgetComparator/index.html index c548a995c0..7739512f13 100644 --- a/v1/WidgetComparator/index.html +++ b/v1/WidgetComparator/index.html @@ -1 +1 @@ - WidgetComparator - Datadog API Client for Python
\ No newline at end of file + WidgetComparator - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetCompareTo/index.html b/v1/WidgetCompareTo/index.html index 575e959064..3637dc4e46 100644 --- a/v1/WidgetCompareTo/index.html +++ b/v1/WidgetCompareTo/index.html @@ -1 +1 @@ - WidgetCompareTo - Datadog API Client for Python

WidgetCompareTo

Timeframe used for the change comparison.

Properties

Name Type Description Notes
value str Timeframe used for the change comparison. must be one of ["hour_before", "day_before", "week_before", "month_before", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetCompareTo - Datadog API Client for Python

WidgetCompareTo

Timeframe used for the change comparison.

Properties

Name Type Description Notes
value str Timeframe used for the change comparison. must be one of ["hour_before", "day_before", "week_before", "month_before", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetConditionalFormat/index.html b/v1/WidgetConditionalFormat/index.html index a871e6979b..16429eb2dd 100644 --- a/v1/WidgetConditionalFormat/index.html +++ b/v1/WidgetConditionalFormat/index.html @@ -1 +1 @@ - WidgetConditionalFormat - Datadog API Client for Python

WidgetConditionalFormat

Define a conditional format for the widget.

Properties

Name Type Description Notes
comparator WidgetComparator
palette WidgetPalette
value float Value for the comparator.
custom_bg_color str Color palette to apply to the background, same values available as palette. [optional]
custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional]
hide_value bool True hides values. [optional]
image_url str Displays an image as the background. [optional]
metric str Metric from the request to correlate this conditional format with. [optional]
timeframe str Defines the displayed timeframe. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetConditionalFormat - Datadog API Client for Python

WidgetConditionalFormat

Define a conditional format for the widget.

Properties

Name Type Description Notes
comparator WidgetComparator
palette WidgetPalette
value float Value for the comparator.
custom_bg_color str Color palette to apply to the background, same values available as palette. [optional]
custom_fg_color str Color palette to apply to the foreground, same values available as palette. [optional]
hide_value bool True hides values. [optional]
image_url str Displays an image as the background. [optional]
metric str Metric from the request to correlate this conditional format with. [optional]
timeframe str Defines the displayed timeframe. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetCustomLink/index.html b/v1/WidgetCustomLink/index.html index 7bafaca35a..b79eee54b9 100644 --- a/v1/WidgetCustomLink/index.html +++ b/v1/WidgetCustomLink/index.html @@ -1 +1 @@ - WidgetCustomLink - Datadog API Client for Python

WidgetCustomLink

Custom links help you connect a data value to a URL, like a Datadog page or your AWS console.

Properties

Name Type Description Notes
label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetCustomLink - Datadog API Client for Python

WidgetCustomLink

Custom links help you connect a data value to a URL, like a Datadog page or your AWS console.

Properties

Name Type Description Notes
label str The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
link str The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetDefinition/index.html b/v1/WidgetDefinition/index.html index fbe9667aea..fb4cfe016b 100644 --- a/v1/WidgetDefinition/index.html +++ b/v1/WidgetDefinition/index.html @@ -1 +1 @@ - WidgetDefinition - Datadog API Client for Python

WidgetDefinition

Definition of the widget.

Properties

Name Type Description Notes
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional]
text_align WidgetTextAlign [optional]
unit str Unit to display with the value. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
group [str] List of tag prefixes to group by. [optional]
group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional]
tags [str] List of tags used to filter the groups reporting a cluster check. [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool (screenboard only) Show the legend for this widget. [optional]
event_size WidgetEventSize [optional]
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
color str Color of the text. [optional]
font_size str Size of the text. [optional]
events [WidgetEvent] List of widget events. [optional]
yaxis WidgetAxis [optional]
no_group_hosts bool Whether to show the hosts that don’t fit in a group. [optional]
no_metric_hosts bool Whether to show the hosts with no metrics. [optional]
node_type WidgetNodeType [optional]
notes str Notes on the title. [optional]
scope [str] List of tags used to filter the map. [optional]
margin WidgetMargin [optional]
sizing WidgetImageSizing [optional]
columns [str] Which columns to display on the widget. [optional]
indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional]
logset str ID of the log set to use. [optional]
message_display WidgetMessageDisplay [optional]
show_date_column bool Whether to show the date column or not [optional]
show_message_column bool Whether to show the message column or not [optional]
sort WidgetMonitorSummarySort [optional]
color_preference WidgetColorPreference [optional]
count int The number of monitors to display. [optional]
display_format WidgetServiceSummaryDisplayFormat [optional]
hide_zero_counts bool Whether to show counts of 0 or not. [optional]
show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional]
start int The start of the list. Typically 0. [optional]
summary_type WidgetSummaryType [optional]
background_color str Background color of the note. [optional]
show_tick bool Whether to show a tick or not. [optional]
tick_edge WidgetTickEdge [optional]
tick_pos str Where to position the tick on an edge. [optional]
autoscale bool Whether to use auto-scaling or not. [optional]
custom_unit str Display a unit of your choice on the widget. [optional]
color_by_groups [str] List of groups used for colors. [optional]
xaxis WidgetAxis [optional]
show_error_budget bool Defined error budget. [optional]
slo_id str ID of the SLO displayed. [optional]
time_windows [WidgetTimeWindows] Times being monitored. [optional]
view_mode WidgetViewMode [optional]
show_breakdown bool Whether to show the latency breakdown or not. [optional]
show_distribution bool Whether to show the latency distribution or not. [optional]
show_errors bool Whether to show the error metrics or not. [optional]
show_hits bool Whether to show the hits metrics or not. [optional]
show_latency bool Whether to show the latency metrics or not. [optional]
show_resource_list bool Whether to show the resource list or not. [optional]
size_format WidgetSizeFormat [optional]
has_search_bar TableWidgetHasSearchBar [optional]
legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional]
legend_layout TimeseriesWidgetLegendLayout [optional]
markers [WidgetMarker] List of markers. [optional]
right_yaxis WidgetAxis [optional]
alert_id str ID of the alert to use in the widget. [optional]
type ToplistWidgetDefinitionType [optional]
viz_type WidgetVizType [optional]
requests [ToplistWidgetRequest] List of top list widget requests. [optional]
check str Name of the check to use in the widget. [optional]
grouping WidgetGrouping [optional]
query str Query to filter the monitors with. [optional]
text str Text to display. [optional]
style HostMapWidgetDefinitionStyle [optional]
view GeomapWidgetDefinitionView [optional]
layout_type WidgetLayoutType [optional]
widgets [Widget] List of widget groups. [optional]
url str URL of the image. [optional]
content str Content of the note. [optional]
view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of "detail"
filters [str] Your environment and primary tag (or * if enabled for your account). [optional]
service str APM service. [optional]
env str APM environment. [optional]
span_name str APM span name. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 18, 2021
\ No newline at end of file + WidgetDefinition - Datadog API Client for Python

WidgetDefinition

Definition of the widget.

Properties

Name Type Description Notes
time WidgetTime [optional]
title str Title of your widget. [optional]
title_align WidgetTextAlign [optional]
title_size str Size of the title. [optional]
precision int Number of decimals to show. If not defined, the widget uses the raw value. [optional]
text_align WidgetTextAlign [optional]
unit str Unit to display with the value. [optional]
custom_links [WidgetCustomLink] List of custom links. [optional]
group [str] List of tag prefixes to group by. [optional]
group_by [str] List of tag prefixes to group by in the case of a cluster check. [optional]
tags [str] List of tags used to filter the groups reporting a cluster check. [optional]
legend_size str Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". [optional]
show_legend bool (screenboard only) Show the legend for this widget. [optional]
event_size WidgetEventSize [optional]
tags_execution str The execution method for multi-value filters. Can be either and or or. [optional]
color str Color of the text. [optional]
font_size str Size of the text. [optional]
events [WidgetEvent] List of widget events. [optional]
yaxis WidgetAxis [optional]
no_group_hosts bool Whether to show the hosts that don’t fit in a group. [optional]
no_metric_hosts bool Whether to show the hosts with no metrics. [optional]
node_type WidgetNodeType [optional]
notes str Notes on the title. [optional]
scope [str] List of tags used to filter the map. [optional]
margin WidgetMargin [optional]
sizing WidgetImageSizing [optional]
columns [str] Which columns to display on the widget. [optional]
indexes [str] An array of index names to query in the stream. Use [] to query all indexes at once. [optional]
logset str ID of the log set to use. [optional]
message_display WidgetMessageDisplay [optional]
show_date_column bool Whether to show the date column or not [optional]
show_message_column bool Whether to show the message column or not [optional]
sort WidgetMonitorSummarySort [optional]
color_preference WidgetColorPreference [optional]
count int The number of monitors to display. [optional]
display_format WidgetServiceSummaryDisplayFormat [optional]
hide_zero_counts bool Whether to show counts of 0 or not. [optional]
show_last_triggered bool Whether to show the time that has elapsed since the monitor/group triggered. [optional]
start int The start of the list. Typically 0. [optional]
summary_type WidgetSummaryType [optional]
background_color str Background color of the note. [optional]
show_tick bool Whether to show a tick or not. [optional]
tick_edge WidgetTickEdge [optional]
tick_pos str Where to position the tick on an edge. [optional]
autoscale bool Whether to use auto-scaling or not. [optional]
custom_unit str Display a unit of your choice on the widget. [optional]
color_by_groups [str] List of groups used for colors. [optional]
xaxis WidgetAxis [optional]
show_error_budget bool Defined error budget. [optional]
slo_id str ID of the SLO displayed. [optional]
time_windows [WidgetTimeWindows] Times being monitored. [optional]
view_mode WidgetViewMode [optional]
show_breakdown bool Whether to show the latency breakdown or not. [optional]
show_distribution bool Whether to show the latency distribution or not. [optional]
show_errors bool Whether to show the error metrics or not. [optional]
show_hits bool Whether to show the hits metrics or not. [optional]
show_latency bool Whether to show the latency metrics or not. [optional]
show_resource_list bool Whether to show the resource list or not. [optional]
size_format WidgetSizeFormat [optional]
has_search_bar TableWidgetHasSearchBar [optional]
legend_columns [TimeseriesWidgetLegendColumn] Columns displayed in the legend. [optional]
legend_layout TimeseriesWidgetLegendLayout [optional]
markers [WidgetMarker] List of markers. [optional]
right_yaxis WidgetAxis [optional]
alert_id str ID of the alert to use in the widget. [optional]
type ToplistWidgetDefinitionType [optional]
viz_type WidgetVizType [optional]
requests [ToplistWidgetRequest] List of top list widget requests. [optional]
check str Name of the check to use in the widget. [optional]
grouping WidgetGrouping [optional]
query str Query to filter the monitors with. [optional]
text str Text to display. [optional]
style HostMapWidgetDefinitionStyle [optional]
view GeomapWidgetDefinitionView [optional]
layout_type WidgetLayoutType [optional]
widgets [Widget] List of widget groups. [optional]
url str URL of the image. [optional]
content str Content of the note. [optional]
view_type str Type of view displayed by the widget. [optional] if omitted the server will use the default value of "detail"
filters [str] Your environment and primary tag (or * if enabled for your account). [optional]
service str APM service. [optional]
env str APM environment. [optional]
span_name str APM span name. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetDisplayType/index.html b/v1/WidgetDisplayType/index.html index 98c133df2f..a61aebbcae 100644 --- a/v1/WidgetDisplayType/index.html +++ b/v1/WidgetDisplayType/index.html @@ -1 +1 @@ - WidgetDisplayType - Datadog API Client for Python

WidgetDisplayType

Type of display to use for the request.

Properties

Name Type Description Notes
value str Type of display to use for the request. must be one of ["area", "bars", "line", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetDisplayType - Datadog API Client for Python

WidgetDisplayType

Type of display to use for the request.

Properties

Name Type Description Notes
value str Type of display to use for the request. must be one of ["area", "bars", "line", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetEvent/index.html b/v1/WidgetEvent/index.html index 0a6c8caac4..7dd7a98297 100644 --- a/v1/WidgetEvent/index.html +++ b/v1/WidgetEvent/index.html @@ -1 +1 @@ - WidgetEvent - Datadog API Client for Python
\ No newline at end of file + WidgetEvent - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetEventSize/index.html b/v1/WidgetEventSize/index.html index bb1de386cb..d4aa0e5936 100644 --- a/v1/WidgetEventSize/index.html +++ b/v1/WidgetEventSize/index.html @@ -1 +1 @@ - WidgetEventSize - Datadog API Client for Python
\ No newline at end of file + WidgetEventSize - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetFieldSort/index.html b/v1/WidgetFieldSort/index.html index d010d62cc3..f7ebc8fef7 100644 --- a/v1/WidgetFieldSort/index.html +++ b/v1/WidgetFieldSort/index.html @@ -1 +1 @@ - WidgetFieldSort - Datadog API Client for Python
\ No newline at end of file + WidgetFieldSort - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetFormula/index.html b/v1/WidgetFormula/index.html index 648f75fa1b..0d1f5002e6 100644 --- a/v1/WidgetFormula/index.html +++ b/v1/WidgetFormula/index.html @@ -1 +1 @@ - WidgetFormula - Datadog API Client for Python
\ No newline at end of file + WidgetFormula - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetFormulaLimit/index.html b/v1/WidgetFormulaLimit/index.html index 5a59b0f37a..a341e1b508 100644 --- a/v1/WidgetFormulaLimit/index.html +++ b/v1/WidgetFormulaLimit/index.html @@ -1 +1 @@ - WidgetFormulaLimit - Datadog API Client for Python
\ No newline at end of file + WidgetFormulaLimit - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetGrouping/index.html b/v1/WidgetGrouping/index.html index 81edc77055..129d1899d0 100644 --- a/v1/WidgetGrouping/index.html +++ b/v1/WidgetGrouping/index.html @@ -1 +1 @@ - WidgetGrouping - Datadog API Client for Python
\ No newline at end of file + WidgetGrouping - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetImageSizing/index.html b/v1/WidgetImageSizing/index.html index b4554dd5c4..e84b360106 100644 --- a/v1/WidgetImageSizing/index.html +++ b/v1/WidgetImageSizing/index.html @@ -1 +1 @@ - WidgetImageSizing - Datadog API Client for Python
\ No newline at end of file + WidgetImageSizing - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetLayout/index.html b/v1/WidgetLayout/index.html index 89766fa8d8..4a4fb0c0dd 100644 --- a/v1/WidgetLayout/index.html +++ b/v1/WidgetLayout/index.html @@ -1 +1 @@ - WidgetLayout - Datadog API Client for Python

WidgetLayout

The layout for a widget on a free dashboard.

Properties

Name Type Description Notes
height int The height of the widget. Should be a non-negative integer.
width int The width of the widget. Should be a non-negative integer.
x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y int The position of the widget on the y (vertical) axis. Should be a non-negative integer.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetLayout - Datadog API Client for Python

WidgetLayout

The layout for a widget on a free dashboard.

Properties

Name Type Description Notes
height int The height of the widget. Should be a non-negative integer.
width int The width of the widget. Should be a non-negative integer.
x int The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y int The position of the widget on the y (vertical) axis. Should be a non-negative integer.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetLayoutType/index.html b/v1/WidgetLayoutType/index.html index 5e3ed9d1cd..88568cf7cd 100644 --- a/v1/WidgetLayoutType/index.html +++ b/v1/WidgetLayoutType/index.html @@ -1 +1 @@ - WidgetLayoutType - Datadog API Client for Python
\ No newline at end of file + WidgetLayoutType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetLineType/index.html b/v1/WidgetLineType/index.html index 6c73647747..2afafa35a6 100644 --- a/v1/WidgetLineType/index.html +++ b/v1/WidgetLineType/index.html @@ -1 +1 @@ - WidgetLineType - Datadog API Client for Python
\ No newline at end of file + WidgetLineType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetLineWidth/index.html b/v1/WidgetLineWidth/index.html index 13bae076a2..dae03f4e00 100644 --- a/v1/WidgetLineWidth/index.html +++ b/v1/WidgetLineWidth/index.html @@ -1 +1 @@ - WidgetLineWidth - Datadog API Client for Python
\ No newline at end of file + WidgetLineWidth - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetLiveSpan/index.html b/v1/WidgetLiveSpan/index.html index 408fdb8711..6eab0ec53d 100644 --- a/v1/WidgetLiveSpan/index.html +++ b/v1/WidgetLiveSpan/index.html @@ -1 +1 @@ - WidgetLiveSpan - Datadog API Client for Python

WidgetLiveSpan

The available timeframes depend on the widget you are using.

Properties

Name Type Description Notes
value str The available timeframes depend on the widget you are using. must be one of ["1m", "5m", "10m", "15m", "30m", "1h", "4h", "1d", "2d", "1w", "1mo", "3mo", "6mo", "1y", "alert", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetLiveSpan - Datadog API Client for Python

WidgetLiveSpan

The available timeframes depend on the widget you are using.

Properties

Name Type Description Notes
value str The available timeframes depend on the widget you are using. must be one of ["1m", "5m", "10m", "15m", "30m", "1h", "4h", "1d", "2d", "1w", "1mo", "3mo", "6mo", "1y", "alert", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetMargin/index.html b/v1/WidgetMargin/index.html index 44445b5e76..bec69fbe26 100644 --- a/v1/WidgetMargin/index.html +++ b/v1/WidgetMargin/index.html @@ -1 +1 @@ - WidgetMargin - Datadog API Client for Python
\ No newline at end of file + WidgetMargin - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetMarker/index.html b/v1/WidgetMarker/index.html index 812b15470f..bd07248ba6 100644 --- a/v1/WidgetMarker/index.html +++ b/v1/WidgetMarker/index.html @@ -1 +1 @@ - WidgetMarker - Datadog API Client for Python

WidgetMarker

Markers allow you to add visual conditional formatting for your graphs.

Properties

Name Type Description Notes
value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.
display_type str Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold [optional]
label str Label to display over the marker. [optional]
time str Timestamp for the widget. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetMarker - Datadog API Client for Python

WidgetMarker

Markers allow you to add visual conditional formatting for your graphs.

Properties

Name Type Description Notes
value str Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.
display_type str Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold [optional]
label str Label to display over the marker. [optional]
time str Timestamp for the widget. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetMessageDisplay/index.html b/v1/WidgetMessageDisplay/index.html index 3cfd6b3e37..4003fab7ff 100644 --- a/v1/WidgetMessageDisplay/index.html +++ b/v1/WidgetMessageDisplay/index.html @@ -1 +1 @@ - WidgetMessageDisplay - Datadog API Client for Python

WidgetMessageDisplay

Amount of log lines to display

Properties

Name Type Description Notes
value str Amount of log lines to display must be one of ["inline", "expanded-md", "expanded-lg", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetMessageDisplay - Datadog API Client for Python

WidgetMessageDisplay

Amount of log lines to display

Properties

Name Type Description Notes
value str Amount of log lines to display must be one of ["inline", "expanded-md", "expanded-lg", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetMonitorSummaryDisplayFormat/index.html b/v1/WidgetMonitorSummaryDisplayFormat/index.html index 1ed3a6ffc0..6bfa8e9fd5 100644 --- a/v1/WidgetMonitorSummaryDisplayFormat/index.html +++ b/v1/WidgetMonitorSummaryDisplayFormat/index.html @@ -1 +1 @@ - WidgetMonitorSummaryDisplayFormat - Datadog API Client for Python

WidgetMonitorSummaryDisplayFormat

What to display on the widget.

Properties

Name Type Description Notes
value str What to display on the widget. must be one of ["counts", "countsAndList", "list", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetMonitorSummaryDisplayFormat - Datadog API Client for Python

WidgetMonitorSummaryDisplayFormat

What to display on the widget.

Properties

Name Type Description Notes
value str What to display on the widget. must be one of ["counts", "countsAndList", "list", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetMonitorSummarySort/index.html b/v1/WidgetMonitorSummarySort/index.html index e9bea30431..68906594e6 100644 --- a/v1/WidgetMonitorSummarySort/index.html +++ b/v1/WidgetMonitorSummarySort/index.html @@ -1 +1 @@ - WidgetMonitorSummarySort - Datadog API Client for Python

WidgetMonitorSummarySort

Widget sorting methods.

Properties

Name Type Description Notes
value str Widget sorting methods. must be one of ["name", "group", "status", "tags", "triggered", "group,asc", "group,desc", "name,asc", "name,desc", "status,asc", "status,desc", "tags,asc", "tags,desc", "triggered,asc", "triggered,desc", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetMonitorSummarySort - Datadog API Client for Python

WidgetMonitorSummarySort

Widget sorting methods.

Properties

Name Type Description Notes
value str Widget sorting methods. must be one of ["name", "group", "status", "tags", "triggered", "group,asc", "group,desc", "name,asc", "name,desc", "status,asc", "status,desc", "tags,asc", "tags,desc", "triggered,asc", "triggered,desc", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetNodeType/index.html b/v1/WidgetNodeType/index.html index bd44e76395..64e486a3c6 100644 --- a/v1/WidgetNodeType/index.html +++ b/v1/WidgetNodeType/index.html @@ -1 +1 @@ - WidgetNodeType - Datadog API Client for Python
\ No newline at end of file + WidgetNodeType - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetOrderBy/index.html b/v1/WidgetOrderBy/index.html index 7abd5d027b..a831b5096f 100644 --- a/v1/WidgetOrderBy/index.html +++ b/v1/WidgetOrderBy/index.html @@ -1 +1 @@ - WidgetOrderBy - Datadog API Client for Python
\ No newline at end of file + WidgetOrderBy - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetPalette/index.html b/v1/WidgetPalette/index.html index aafd5598d8..998ebf8cb4 100644 --- a/v1/WidgetPalette/index.html +++ b/v1/WidgetPalette/index.html @@ -1 +1 @@ - WidgetPalette - Datadog API Client for Python

WidgetPalette

Color palette to apply.

Properties

Name Type Description Notes
value str Color palette to apply. must be one of ["blue", "custom_bg", "custom_image", "custom_text", "gray_on_white", "grey", "green", "orange", "red", "red_on_white", "white_on_gray", "white_on_green", "green_on_white", "white_on_red", "white_on_yellow", "yellow_on_white", "black_on_light_yellow", "black_on_light_green", "black_on_light_red", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 5, 2020
\ No newline at end of file + WidgetPalette - Datadog API Client for Python

WidgetPalette

Color palette to apply.

Properties

Name Type Description Notes
value str Color palette to apply. must be one of ["blue", "custom_bg", "custom_image", "custom_text", "gray_on_white", "grey", "green", "orange", "red", "red_on_white", "white_on_gray", "white_on_green", "green_on_white", "white_on_red", "white_on_yellow", "yellow_on_white", "black_on_light_yellow", "black_on_light_green", "black_on_light_red", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetRequestStyle/index.html b/v1/WidgetRequestStyle/index.html index 69caca599b..0ef2464735 100644 --- a/v1/WidgetRequestStyle/index.html +++ b/v1/WidgetRequestStyle/index.html @@ -1 +1 @@ - WidgetRequestStyle - Datadog API Client for Python
\ No newline at end of file + WidgetRequestStyle - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetServiceSummaryDisplayFormat/index.html b/v1/WidgetServiceSummaryDisplayFormat/index.html index d1cd417372..a1ee757b37 100644 --- a/v1/WidgetServiceSummaryDisplayFormat/index.html +++ b/v1/WidgetServiceSummaryDisplayFormat/index.html @@ -1 +1 @@ - WidgetServiceSummaryDisplayFormat - Datadog API Client for Python

WidgetServiceSummaryDisplayFormat

Number of columns to display.

Properties

Name Type Description Notes
value str Number of columns to display. must be one of ["one_column", "two_column", "three_column", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetServiceSummaryDisplayFormat - Datadog API Client for Python

WidgetServiceSummaryDisplayFormat

Number of columns to display.

Properties

Name Type Description Notes
value str Number of columns to display. must be one of ["one_column", "two_column", "three_column", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetSizeFormat/index.html b/v1/WidgetSizeFormat/index.html index 3dc3c1400f..de2c137232 100644 --- a/v1/WidgetSizeFormat/index.html +++ b/v1/WidgetSizeFormat/index.html @@ -1 +1 @@ - WidgetSizeFormat - Datadog API Client for Python
\ No newline at end of file + WidgetSizeFormat - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetSort/index.html b/v1/WidgetSort/index.html index ea577d5cce..82d953c5f3 100644 --- a/v1/WidgetSort/index.html +++ b/v1/WidgetSort/index.html @@ -1 +1 @@ - WidgetSort - Datadog API Client for Python
\ No newline at end of file + WidgetSort - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetStyle/index.html b/v1/WidgetStyle/index.html index 62c5da2ccc..44b75067cc 100644 --- a/v1/WidgetStyle/index.html +++ b/v1/WidgetStyle/index.html @@ -1 +1 @@ - WidgetStyle - Datadog API Client for Python
\ No newline at end of file + WidgetStyle - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetSummaryType/index.html b/v1/WidgetSummaryType/index.html index 18ad15acb8..319e58d7bd 100644 --- a/v1/WidgetSummaryType/index.html +++ b/v1/WidgetSummaryType/index.html @@ -1 +1 @@ - WidgetSummaryType - Datadog API Client for Python

WidgetSummaryType

Which summary type should be used.

Properties

Name Type Description Notes
value str Which summary type should be used. must be one of ["monitors", "groups", "combined", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetSummaryType - Datadog API Client for Python

WidgetSummaryType

Which summary type should be used.

Properties

Name Type Description Notes
value str Which summary type should be used. must be one of ["monitors", "groups", "combined", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetTextAlign/index.html b/v1/WidgetTextAlign/index.html index 4e6ebbd0eb..4fd45be804 100644 --- a/v1/WidgetTextAlign/index.html +++ b/v1/WidgetTextAlign/index.html @@ -1 +1 @@ - WidgetTextAlign - Datadog API Client for Python
\ No newline at end of file + WidgetTextAlign - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetTickEdge/index.html b/v1/WidgetTickEdge/index.html index 58049040fe..3030a18d0a 100644 --- a/v1/WidgetTickEdge/index.html +++ b/v1/WidgetTickEdge/index.html @@ -1 +1 @@ - WidgetTickEdge - Datadog API Client for Python

WidgetTickEdge

Define how you want to align the text on the widget.

Properties

Name Type Description Notes
value str Define how you want to align the text on the widget. must be one of ["bottom", "left", "right", "top", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetTickEdge - Datadog API Client for Python

WidgetTickEdge

Define how you want to align the text on the widget.

Properties

Name Type Description Notes
value str Define how you want to align the text on the widget. must be one of ["bottom", "left", "right", "top", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetTime/index.html b/v1/WidgetTime/index.html index 7f3ab5e4c2..d7ea320dff 100644 --- a/v1/WidgetTime/index.html +++ b/v1/WidgetTime/index.html @@ -1 +1 @@ - WidgetTime - Datadog API Client for Python
\ No newline at end of file + WidgetTime - Datadog API Client for Python
\ No newline at end of file diff --git a/v1/WidgetTimeWindows/index.html b/v1/WidgetTimeWindows/index.html index ad27d2641b..3a5e386382 100644 --- a/v1/WidgetTimeWindows/index.html +++ b/v1/WidgetTimeWindows/index.html @@ -1 +1 @@ - WidgetTimeWindows - Datadog API Client for Python

WidgetTimeWindows

Define a time window.

Properties

Name Type Description Notes
value str Define a time window. must be one of ["7d", "30d", "90d", "week_to_date", "previous_week", "month_to_date", "previous_month", "global_time", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 25, 2021
\ No newline at end of file + WidgetTimeWindows - Datadog API Client for Python

WidgetTimeWindows

Define a time window.

Properties

Name Type Description Notes
value str Define a time window. must be one of ["7d", "30d", "90d", "week_to_date", "previous_week", "month_to_date", "previous_month", "global_time", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetViewMode/index.html b/v1/WidgetViewMode/index.html index b41b764fac..4c9d0b5d5a 100644 --- a/v1/WidgetViewMode/index.html +++ b/v1/WidgetViewMode/index.html @@ -1 +1 @@ - WidgetViewMode - Datadog API Client for Python

WidgetViewMode

Define how you want the SLO to be displayed.

Properties

Name Type Description Notes
value str Define how you want the SLO to be displayed. must be one of ["overall", "component", "both", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetViewMode - Datadog API Client for Python

WidgetViewMode

Define how you want the SLO to be displayed.

Properties

Name Type Description Notes
value str Define how you want the SLO to be displayed. must be one of ["overall", "component", "both", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v1/WidgetVizType/index.html b/v1/WidgetVizType/index.html index 52a872405d..4b648e5514 100644 --- a/v1/WidgetVizType/index.html +++ b/v1/WidgetVizType/index.html @@ -1 +1 @@ - WidgetVizType - Datadog API Client for Python

WidgetVizType

Whether to display the Alert Graph as a timeseries or a top list.

Properties

Name Type Description Notes
value str Whether to display the Alert Graph as a timeseries or a top list. must be one of ["timeseries", "toplist", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + WidgetVizType - Datadog API Client for Python

WidgetVizType

Whether to display the Alert Graph as a timeseries or a top list.

Properties

Name Type Description Notes
value str Whether to display the Alert Graph as a timeseries or a top list. must be one of ["timeseries", "toplist", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/APIErrorResponse/index.html b/v2/APIErrorResponse/index.html index 1dc6fd721d..143f795f18 100644 --- a/v2/APIErrorResponse/index.html +++ b/v2/APIErrorResponse/index.html @@ -1 +1 @@ - APIErrorResponse - Datadog API Client for Python
\ No newline at end of file + APIErrorResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyCreateAttributes/index.html b/v2/APIKeyCreateAttributes/index.html index 5fe358440b..0c8a6880da 100644 --- a/v2/APIKeyCreateAttributes/index.html +++ b/v2/APIKeyCreateAttributes/index.html @@ -1 +1 @@ - APIKeyCreateAttributes - Datadog API Client for Python
\ No newline at end of file + APIKeyCreateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyCreateData/index.html b/v2/APIKeyCreateData/index.html index 9ee55cfc10..13c2f99ec9 100644 --- a/v2/APIKeyCreateData/index.html +++ b/v2/APIKeyCreateData/index.html @@ -1 +1 @@ - APIKeyCreateData - Datadog API Client for Python
\ No newline at end of file + APIKeyCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyCreateRequest/index.html b/v2/APIKeyCreateRequest/index.html index 431ca560e3..57b676516b 100644 --- a/v2/APIKeyCreateRequest/index.html +++ b/v2/APIKeyCreateRequest/index.html @@ -1 +1 @@ - APIKeyCreateRequest - Datadog API Client for Python
\ No newline at end of file + APIKeyCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyRelationships/index.html b/v2/APIKeyRelationships/index.html index 9628b910df..42ea0f8e77 100644 --- a/v2/APIKeyRelationships/index.html +++ b/v2/APIKeyRelationships/index.html @@ -1 +1 @@ - APIKeyRelationships - Datadog API Client for Python
\ No newline at end of file + APIKeyRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyResponse/index.html b/v2/APIKeyResponse/index.html index 16d8b2c57c..b2e9e2bfc5 100644 --- a/v2/APIKeyResponse/index.html +++ b/v2/APIKeyResponse/index.html @@ -1 +1 @@ - APIKeyResponse - Datadog API Client for Python
\ No newline at end of file + APIKeyResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyResponseIncludedItem/index.html b/v2/APIKeyResponseIncludedItem/index.html index ffa67bf014..a666c267f8 100644 --- a/v2/APIKeyResponseIncludedItem/index.html +++ b/v2/APIKeyResponseIncludedItem/index.html @@ -1 +1 @@ - APIKeyResponseIncludedItem - Datadog API Client for Python
\ No newline at end of file + APIKeyResponseIncludedItem - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyUpdateAttributes/index.html b/v2/APIKeyUpdateAttributes/index.html index 89f6b77d6f..baa7cb38fb 100644 --- a/v2/APIKeyUpdateAttributes/index.html +++ b/v2/APIKeyUpdateAttributes/index.html @@ -1 +1 @@ - APIKeyUpdateAttributes - Datadog API Client for Python
\ No newline at end of file + APIKeyUpdateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyUpdateData/index.html b/v2/APIKeyUpdateData/index.html index abec4c99aa..40a9e9c2aa 100644 --- a/v2/APIKeyUpdateData/index.html +++ b/v2/APIKeyUpdateData/index.html @@ -1 +1 @@ - APIKeyUpdateData - Datadog API Client for Python
\ No newline at end of file + APIKeyUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeyUpdateRequest/index.html b/v2/APIKeyUpdateRequest/index.html index 0bff42571c..a9bdab7646 100644 --- a/v2/APIKeyUpdateRequest/index.html +++ b/v2/APIKeyUpdateRequest/index.html @@ -1 +1 @@ - APIKeyUpdateRequest - Datadog API Client for Python
\ No newline at end of file + APIKeyUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeysResponse/index.html b/v2/APIKeysResponse/index.html index 4f8fe0d4fe..e03f3fd0c9 100644 --- a/v2/APIKeysResponse/index.html +++ b/v2/APIKeysResponse/index.html @@ -1 +1 @@ - APIKeysResponse - Datadog API Client for Python
\ No newline at end of file + APIKeysResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/APIKeysSort/index.html b/v2/APIKeysSort/index.html index 308ff7d43a..1cbc71c1d1 100644 --- a/v2/APIKeysSort/index.html +++ b/v2/APIKeysSort/index.html @@ -1 +1 @@ - APIKeysSort - Datadog API Client for Python

APIKeysSort

Sorting options

Properties

Name Type Description Notes
value str Sorting options defaults to "name", must be one of ["created_at", "-created_at", "last4", "-last4", "modified_at", "-modified_at", "name", "-name", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 11, 2021
\ No newline at end of file + APIKeysSort - Datadog API Client for Python

APIKeysSort

Sorting options

Properties

Name Type Description Notes
value str Sorting options defaults to "name", must be one of ["created_at", "-created_at", "last4", "-last4", "modified_at", "-modified_at", "name", "-name", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/APIKeysType/index.html b/v2/APIKeysType/index.html index fb53db7cd2..e4c2589bc6 100644 --- a/v2/APIKeysType/index.html +++ b/v2/APIKeysType/index.html @@ -1 +1 @@ - APIKeysType - Datadog API Client for Python
\ No newline at end of file + APIKeysType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyCreateAttributes/index.html b/v2/ApplicationKeyCreateAttributes/index.html index 16773d3e8d..6e4a60efe4 100644 --- a/v2/ApplicationKeyCreateAttributes/index.html +++ b/v2/ApplicationKeyCreateAttributes/index.html @@ -1 +1 @@ - ApplicationKeyCreateAttributes - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyCreateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyCreateData/index.html b/v2/ApplicationKeyCreateData/index.html index c6ed328027..9f4da3c67d 100644 --- a/v2/ApplicationKeyCreateData/index.html +++ b/v2/ApplicationKeyCreateData/index.html @@ -1 +1 @@ - ApplicationKeyCreateData - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyCreateRequest/index.html b/v2/ApplicationKeyCreateRequest/index.html index 4fccd279ec..f434170677 100644 --- a/v2/ApplicationKeyCreateRequest/index.html +++ b/v2/ApplicationKeyCreateRequest/index.html @@ -1 +1 @@ - ApplicationKeyCreateRequest - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyRelationships/index.html b/v2/ApplicationKeyRelationships/index.html index c241dace78..e94eba3cce 100644 --- a/v2/ApplicationKeyRelationships/index.html +++ b/v2/ApplicationKeyRelationships/index.html @@ -1 +1 @@ - ApplicationKeyRelationships - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyResponse/index.html b/v2/ApplicationKeyResponse/index.html index 3fd4a74122..b68f94a134 100644 --- a/v2/ApplicationKeyResponse/index.html +++ b/v2/ApplicationKeyResponse/index.html @@ -1 +1 @@ - ApplicationKeyResponse - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyResponseIncludedItem/index.html b/v2/ApplicationKeyResponseIncludedItem/index.html index ec92decaac..d8e29cdbb0 100644 --- a/v2/ApplicationKeyResponseIncludedItem/index.html +++ b/v2/ApplicationKeyResponseIncludedItem/index.html @@ -1 +1 @@ - ApplicationKeyResponseIncludedItem - Datadog API Client for Python

ApplicationKeyResponseIncludedItem

An object related to an application key.

Properties

Name Type Description Notes
attributes RoleAttributes [optional]
id str ID of the role. [optional]
relationships RoleResponseRelationships [optional]
type RolesType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + ApplicationKeyResponseIncludedItem - Datadog API Client for Python

ApplicationKeyResponseIncludedItem

An object related to an application key.

Properties

Name Type Description Notes
attributes RoleAttributes [optional]
id str ID of the role. [optional]
relationships RoleResponseRelationships [optional]
type RolesType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/ApplicationKeyUpdateAttributes/index.html b/v2/ApplicationKeyUpdateAttributes/index.html index 2732891e16..715bb57025 100644 --- a/v2/ApplicationKeyUpdateAttributes/index.html +++ b/v2/ApplicationKeyUpdateAttributes/index.html @@ -1 +1 @@ - ApplicationKeyUpdateAttributes - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyUpdateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyUpdateData/index.html b/v2/ApplicationKeyUpdateData/index.html index 242a695196..625e7339f7 100644 --- a/v2/ApplicationKeyUpdateData/index.html +++ b/v2/ApplicationKeyUpdateData/index.html @@ -1 +1 @@ - ApplicationKeyUpdateData - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeyUpdateRequest/index.html b/v2/ApplicationKeyUpdateRequest/index.html index ff911a1e6b..e32691e421 100644 --- a/v2/ApplicationKeyUpdateRequest/index.html +++ b/v2/ApplicationKeyUpdateRequest/index.html @@ -1 +1 @@ - ApplicationKeyUpdateRequest - Datadog API Client for Python
\ No newline at end of file + ApplicationKeyUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ApplicationKeysSort/index.html b/v2/ApplicationKeysSort/index.html index b7f1292d2d..a9e0cafd98 100644 --- a/v2/ApplicationKeysSort/index.html +++ b/v2/ApplicationKeysSort/index.html @@ -1 +1 @@ - ApplicationKeysSort - Datadog API Client for Python

ApplicationKeysSort

Sorting options

Properties

Name Type Description Notes
value str Sorting options defaults to "name", must be one of ["created_at", "-created_at", "last4", "-last4", "name", "-name", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 11, 2021
\ No newline at end of file + ApplicationKeysSort - Datadog API Client for Python

ApplicationKeysSort

Sorting options

Properties

Name Type Description Notes
value str Sorting options defaults to "name", must be one of ["created_at", "-created_at", "last4", "-last4", "name", "-name", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/ApplicationKeysType/index.html b/v2/ApplicationKeysType/index.html index b79134f098..e045b3ccb4 100644 --- a/v2/ApplicationKeysType/index.html +++ b/v2/ApplicationKeysType/index.html @@ -1 +1 @@ - ApplicationKeysType - Datadog API Client for Python

ApplicationKeysType

Application Keys resource type.

Properties

Name Type Description Notes
value str Application Keys resource type. defaults to "application_keys", must be one of ["application_keys", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 5, 2021
\ No newline at end of file + ApplicationKeysType - Datadog API Client for Python

ApplicationKeysType

Application Keys resource type.

Properties

Name Type Description Notes
value str Application Keys resource type. defaults to "application_keys", must be one of ["application_keys", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/Creator/index.html b/v2/Creator/index.html index 3e7bf3ba43..77152bd616 100644 --- a/v2/Creator/index.html +++ b/v2/Creator/index.html @@ -1 +1 @@ - Creator - Datadog API Client for Python

Creator

Creator of the object.

Properties

Name Type Description Notes
email str Email of the creator. [optional]
handle str Handle of the creator. [optional]
name str Name of the creator. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + Creator - Datadog API Client for Python

Creator

Creator of the object.

Properties

Name Type Description Notes
email str Email of the creator. [optional]
handle str Handle of the creator. [optional]
name str Name of the creator. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/DashboardListAddItemsRequest/index.html b/v2/DashboardListAddItemsRequest/index.html index 9b73492537..161b3bd098 100644 --- a/v2/DashboardListAddItemsRequest/index.html +++ b/v2/DashboardListAddItemsRequest/index.html @@ -1 +1 @@ - DashboardListAddItemsRequest - Datadog API Client for Python
\ No newline at end of file + DashboardListAddItemsRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListAddItemsResponse/index.html b/v2/DashboardListAddItemsResponse/index.html index d2bfa63367..ffbd50061f 100644 --- a/v2/DashboardListAddItemsResponse/index.html +++ b/v2/DashboardListAddItemsResponse/index.html @@ -1 +1 @@ - DashboardListAddItemsResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListAddItemsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListDeleteItemsRequest/index.html b/v2/DashboardListDeleteItemsRequest/index.html index 212306a653..ce9b52fa4f 100644 --- a/v2/DashboardListDeleteItemsRequest/index.html +++ b/v2/DashboardListDeleteItemsRequest/index.html @@ -1 +1 @@ - DashboardListDeleteItemsRequest - Datadog API Client for Python
\ No newline at end of file + DashboardListDeleteItemsRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListDeleteItemsResponse/index.html b/v2/DashboardListDeleteItemsResponse/index.html index b0ba43718c..da4f7db3c9 100644 --- a/v2/DashboardListDeleteItemsResponse/index.html +++ b/v2/DashboardListDeleteItemsResponse/index.html @@ -1 +1 @@ - DashboardListDeleteItemsResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListDeleteItemsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListItem/index.html b/v2/DashboardListItem/index.html index 4e93a8ae0b..d755eb694e 100644 --- a/v2/DashboardListItem/index.html +++ b/v2/DashboardListItem/index.html @@ -1 +1 @@ - DashboardListItem - Datadog API Client for Python

DashboardListItem

A dashboard within a list.

Properties

Name Type Description Notes
id str ID of the dashboard.
type DashboardType
author Creator [optional]
created datetime Date of creation of the dashboard. [optional][readonly]
icon str URL to the icon of the dashboard. [optional][readonly]
is_favorite bool Whether or not the dashboard is in the favorites. [optional][readonly]
is_read_only bool Whether or not the dashboard is read only. [optional][readonly]
is_shared bool Whether the dashboard is publicly shared or not. [optional][readonly]
modified datetime Date of last edition of the dashboard. [optional][readonly]
popularity int Popularity of the dashboard. [optional][readonly]
title str Title of the dashboard. [optional][readonly]
url str URL path to the dashboard. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + DashboardListItem - Datadog API Client for Python

DashboardListItem

A dashboard within a list.

Properties

Name Type Description Notes
id str ID of the dashboard.
type DashboardType
author Creator [optional]
created datetime Date of creation of the dashboard. [optional][readonly]
icon str URL to the icon of the dashboard. [optional][readonly]
is_favorite bool Whether or not the dashboard is in the favorites. [optional][readonly]
is_read_only bool Whether or not the dashboard is read only. [optional][readonly]
is_shared bool Whether the dashboard is publicly shared or not. [optional][readonly]
modified datetime Date of last edition of the dashboard. [optional][readonly]
popularity int Popularity of the dashboard. [optional][readonly]
title str Title of the dashboard. [optional][readonly]
url str URL path to the dashboard. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/DashboardListItemRequest/index.html b/v2/DashboardListItemRequest/index.html index 9052084c86..2fc43aacfd 100644 --- a/v2/DashboardListItemRequest/index.html +++ b/v2/DashboardListItemRequest/index.html @@ -1 +1 @@ - DashboardListItemRequest - Datadog API Client for Python
\ No newline at end of file + DashboardListItemRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListItemResponse/index.html b/v2/DashboardListItemResponse/index.html index 5c4ba1194d..d754d4554e 100644 --- a/v2/DashboardListItemResponse/index.html +++ b/v2/DashboardListItemResponse/index.html @@ -1 +1 @@ - DashboardListItemResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListItemResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListItems/index.html b/v2/DashboardListItems/index.html index fb22e253a9..2a919e9bb3 100644 --- a/v2/DashboardListItems/index.html +++ b/v2/DashboardListItems/index.html @@ -1 +1 @@ - DashboardListItems - Datadog API Client for Python
\ No newline at end of file + DashboardListItems - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListUpdateItemsRequest/index.html b/v2/DashboardListUpdateItemsRequest/index.html index 2166f64a62..d52332e15f 100644 --- a/v2/DashboardListUpdateItemsRequest/index.html +++ b/v2/DashboardListUpdateItemsRequest/index.html @@ -1 +1 @@ - DashboardListUpdateItemsRequest - Datadog API Client for Python
\ No newline at end of file + DashboardListUpdateItemsRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListUpdateItemsResponse/index.html b/v2/DashboardListUpdateItemsResponse/index.html index 1d67b74c24..c82318fc23 100644 --- a/v2/DashboardListUpdateItemsResponse/index.html +++ b/v2/DashboardListUpdateItemsResponse/index.html @@ -1 +1 @@ - DashboardListUpdateItemsResponse - Datadog API Client for Python
\ No newline at end of file + DashboardListUpdateItemsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/DashboardListsApi/index.html b/v2/DashboardListsApi/index.html index 8955ba89d0..92ce15b2db 100644 --- a/v2/DashboardListsApi/index.html +++ b/v2/DashboardListsApi/index.html @@ -150,4 +150,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling DashboardListsApi->update_dashboard_list_items: %s\n" % e) -

Parameters

Name Type Description Notes
dashboard_list_id int ID of the dashboard list to update items from.
body DashboardListUpdateItemsRequest New dashboards of the dashboard list.

Return type

DashboardListUpdateItemsResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
dashboard_list_id int ID of the dashboard list to update items from.
body DashboardListUpdateItemsRequest New dashboards of the dashboard list.

Return type

DashboardListUpdateItemsResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/DashboardType/index.html b/v2/DashboardType/index.html index 7bd4167dc9..ce6f31153e 100644 --- a/v2/DashboardType/index.html +++ b/v2/DashboardType/index.html @@ -1 +1 @@ - DashboardType - Datadog API Client for Python

DashboardType

The type of the dashboard.

Properties

Name Type Description Notes
value str The type of the dashboard. must be one of ["custom_timeboard", "custom_screenboard", "integration_screenboard", "integration_timeboard", "host_timeboard", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + DashboardType - Datadog API Client for Python

DashboardType

The type of the dashboard.

Properties

Name Type Description Notes
value str The type of the dashboard. must be one of ["custom_timeboard", "custom_screenboard", "integration_screenboard", "integration_timeboard", "host_timeboard", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/FullAPIKey/index.html b/v2/FullAPIKey/index.html index 7376f0122c..97260f9571 100644 --- a/v2/FullAPIKey/index.html +++ b/v2/FullAPIKey/index.html @@ -1 +1 @@ - FullAPIKey - Datadog API Client for Python
\ No newline at end of file + FullAPIKey - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/FullAPIKeyAttributes/index.html b/v2/FullAPIKeyAttributes/index.html index a0d3fd4657..3e275ce509 100644 --- a/v2/FullAPIKeyAttributes/index.html +++ b/v2/FullAPIKeyAttributes/index.html @@ -1 +1 @@ - FullAPIKeyAttributes - Datadog API Client for Python

FullAPIKeyAttributes

Attributes of a full API key.

Properties

Name Type Description Notes
created_at str Creation date of the API key. [optional][readonly]
key str The API key. [optional][readonly]
last4 str The last four characters of the API key. [optional][readonly]
modified_at str Date the API key was last modified. [optional][readonly]
name str Name of the API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 18, 2020
\ No newline at end of file + FullAPIKeyAttributes - Datadog API Client for Python

FullAPIKeyAttributes

Attributes of a full API key.

Properties

Name Type Description Notes
created_at str Creation date of the API key. [optional][readonly]
key str The API key. [optional][readonly]
last4 str The last four characters of the API key. [optional][readonly]
modified_at str Date the API key was last modified. [optional][readonly]
name str Name of the API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/FullApplicationKey/index.html b/v2/FullApplicationKey/index.html index f9017a7bfe..cd7e9cde9a 100644 --- a/v2/FullApplicationKey/index.html +++ b/v2/FullApplicationKey/index.html @@ -1 +1 @@ - FullApplicationKey - Datadog API Client for Python
\ No newline at end of file + FullApplicationKey - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/FullApplicationKeyAttributes/index.html b/v2/FullApplicationKeyAttributes/index.html index 4f959adfe2..950d0f52f6 100644 --- a/v2/FullApplicationKeyAttributes/index.html +++ b/v2/FullApplicationKeyAttributes/index.html @@ -1 +1 @@ - FullApplicationKeyAttributes - Datadog API Client for Python

FullApplicationKeyAttributes

Attributes of a full application key.

Properties

Name Type Description Notes
created_at str Creation date of the application key. [optional][readonly]
key str The application key. [optional][readonly]
last4 str The last four characters of the application key. [optional][readonly]
name str Name of the application key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 5, 2021
\ No newline at end of file + FullApplicationKeyAttributes - Datadog API Client for Python

FullApplicationKeyAttributes

Attributes of a full application key.

Properties

Name Type Description Notes
created_at str Creation date of the application key. [optional][readonly]
key str The application key. [optional][readonly]
last4 str The last four characters of the application key. [optional][readonly]
name str Name of the application key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentCreateAttributes/index.html b/v2/IncidentCreateAttributes/index.html index dbe6657ce1..a774967b7c 100644 --- a/v2/IncidentCreateAttributes/index.html +++ b/v2/IncidentCreateAttributes/index.html @@ -1 +1 @@ - IncidentCreateAttributes - Datadog API Client for Python

IncidentCreateAttributes

The incident's attributes for a create request.

Properties

Name Type Description Notes
customer_impacted bool A flag indicating whether the incident caused customer impact.
title str The title of the incident, which summarizes what happened.
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional]
initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional]
notification_handles [str] Notification handles that will be notified of the incident at creation. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentCreateAttributes - Datadog API Client for Python

IncidentCreateAttributes

The incident's attributes for a create request.

Properties

Name Type Description Notes
customer_impacted bool A flag indicating whether the incident caused customer impact.
title str The title of the incident, which summarizes what happened.
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to create initial selections. [optional]
initial_timeline_cells [IncidentTimelineCellCreateAttributes] An array of initial timeline cells to be placed at the beginning of the incident timeline. [optional]
notification_handles [str] Notification handles that will be notified of the incident at creation. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentCreateData/index.html b/v2/IncidentCreateData/index.html index 203fb25984..c6637b5038 100644 --- a/v2/IncidentCreateData/index.html +++ b/v2/IncidentCreateData/index.html @@ -1 +1 @@ - IncidentCreateData - Datadog API Client for Python
\ No newline at end of file + IncidentCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentCreateRelationships/index.html b/v2/IncidentCreateRelationships/index.html index 2fd9279e15..a71e988ad5 100644 --- a/v2/IncidentCreateRelationships/index.html +++ b/v2/IncidentCreateRelationships/index.html @@ -1 +1 @@ - IncidentCreateRelationships - Datadog API Client for Python
\ No newline at end of file + IncidentCreateRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentCreateRequest/index.html b/v2/IncidentCreateRequest/index.html index a5e42e460f..2c0f6205a7 100644 --- a/v2/IncidentCreateRequest/index.html +++ b/v2/IncidentCreateRequest/index.html @@ -1 +1 @@ - IncidentCreateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentFieldAttributes/index.html b/v2/IncidentFieldAttributes/index.html index e7df4f43ca..011df16ad7 100644 --- a/v2/IncidentFieldAttributes/index.html +++ b/v2/IncidentFieldAttributes/index.html @@ -1 +1 @@ - IncidentFieldAttributes - Datadog API Client for Python

IncidentFieldAttributes

Dynamic fields for which selections can be made, with field names as keys.

Properties

Name Type Description Notes
type IncidentFieldAttributesValueType
value [str] The multiple values selected for this field. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentFieldAttributes - Datadog API Client for Python

IncidentFieldAttributes

Dynamic fields for which selections can be made, with field names as keys.

Properties

Name Type Description Notes
type IncidentFieldAttributesValueType
value [str] The multiple values selected for this field. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentFieldAttributesMultipleValue/index.html b/v2/IncidentFieldAttributesMultipleValue/index.html index 15feeb3ce7..8d28b5c34f 100644 --- a/v2/IncidentFieldAttributesMultipleValue/index.html +++ b/v2/IncidentFieldAttributesMultipleValue/index.html @@ -1 +1 @@ - IncidentFieldAttributesMultipleValue - Datadog API Client for Python
\ No newline at end of file + IncidentFieldAttributesMultipleValue - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentFieldAttributesSingleValue/index.html b/v2/IncidentFieldAttributesSingleValue/index.html index b2dd0bd75c..96ca20b117 100644 --- a/v2/IncidentFieldAttributesSingleValue/index.html +++ b/v2/IncidentFieldAttributesSingleValue/index.html @@ -1 +1 @@ - IncidentFieldAttributesSingleValue - Datadog API Client for Python
\ No newline at end of file + IncidentFieldAttributesSingleValue - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentFieldAttributesSingleValueType/index.html b/v2/IncidentFieldAttributesSingleValueType/index.html index f817c5ee86..aff64fbfa6 100644 --- a/v2/IncidentFieldAttributesSingleValueType/index.html +++ b/v2/IncidentFieldAttributesSingleValueType/index.html @@ -1 +1 @@ - IncidentFieldAttributesSingleValueType - Datadog API Client for Python

IncidentFieldAttributesSingleValueType

Type of the single value field definitions.

Properties

Name Type Description Notes
value str Type of the single value field definitions. defaults to "dropdown", must be one of ["dropdown", "textbox", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentFieldAttributesSingleValueType - Datadog API Client for Python

IncidentFieldAttributesSingleValueType

Type of the single value field definitions.

Properties

Name Type Description Notes
value str Type of the single value field definitions. defaults to "dropdown", must be one of ["dropdown", "textbox", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentFieldAttributesValueType/index.html b/v2/IncidentFieldAttributesValueType/index.html index 1529cf4b1d..8cd9d57754 100644 --- a/v2/IncidentFieldAttributesValueType/index.html +++ b/v2/IncidentFieldAttributesValueType/index.html @@ -1 +1 @@ - IncidentFieldAttributesValueType - Datadog API Client for Python

IncidentFieldAttributesValueType

Type of the single value field definitions.

Properties

Name Type Description Notes
value str Type of the single value field definitions. defaults to "multiselect", must be one of ["multiselect", "textarray", "metrictag", "autocomplete", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentFieldAttributesValueType - Datadog API Client for Python

IncidentFieldAttributesValueType

Type of the single value field definitions.

Properties

Name Type Description Notes
value str Type of the single value field definitions. defaults to "multiselect", must be one of ["multiselect", "textarray", "metrictag", "autocomplete", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentIntegrationMetadataType/index.html b/v2/IncidentIntegrationMetadataType/index.html index 73a9a57ec2..7c74176022 100644 --- a/v2/IncidentIntegrationMetadataType/index.html +++ b/v2/IncidentIntegrationMetadataType/index.html @@ -1 +1 @@ - IncidentIntegrationMetadataType - Datadog API Client for Python

IncidentIntegrationMetadataType

Integration metadata resource type.

Properties

Name Type Description Notes
value str Integration metadata resource type. defaults to "incident_integration_metadata", must be one of ["incident_integration_metadata", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentIntegrationMetadataType - Datadog API Client for Python

IncidentIntegrationMetadataType

Integration metadata resource type.

Properties

Name Type Description Notes
value str Integration metadata resource type. defaults to "incident_integration_metadata", must be one of ["incident_integration_metadata", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentPostmortemType/index.html b/v2/IncidentPostmortemType/index.html index aaf8f38bd1..139be9da48 100644 --- a/v2/IncidentPostmortemType/index.html +++ b/v2/IncidentPostmortemType/index.html @@ -1 +1 @@ - IncidentPostmortemType - Datadog API Client for Python

IncidentPostmortemType

Incident postmortem resource type.

Properties

Name Type Description Notes
value str Incident postmortem resource type. defaults to "incident_postmortems", must be one of ["incident_postmortems", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentPostmortemType - Datadog API Client for Python

IncidentPostmortemType

Incident postmortem resource type.

Properties

Name Type Description Notes
value str Incident postmortem resource type. defaults to "incident_postmortems", must be one of ["incident_postmortems", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentRelatedObject/index.html b/v2/IncidentRelatedObject/index.html index b84426f583..8e1b67cc04 100644 --- a/v2/IncidentRelatedObject/index.html +++ b/v2/IncidentRelatedObject/index.html @@ -1 +1 @@ - IncidentRelatedObject - Datadog API Client for Python
\ No newline at end of file + IncidentRelatedObject - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentResponse/index.html b/v2/IncidentResponse/index.html index b94cd97327..e7ffda5561 100644 --- a/v2/IncidentResponse/index.html +++ b/v2/IncidentResponse/index.html @@ -1 +1 @@ - IncidentResponse - Datadog API Client for Python
\ No newline at end of file + IncidentResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentResponseAttributes/index.html b/v2/IncidentResponseAttributes/index.html index 42f70edb06..57fe07b20a 100644 --- a/v2/IncidentResponseAttributes/index.html +++ b/v2/IncidentResponseAttributes/index.html @@ -1 +1 @@ - IncidentResponseAttributes - Datadog API Client for Python

IncidentResponseAttributes

The incident's attributes from a response.

Properties

Name Type Description Notes
title str The title of the incident, which summarizes what happened.
created datetime Timestamp when the incident was created. [optional][readonly]
customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. [optional][readonly]
customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional]
customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional]
customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional]
customer_impacted bool A flag indicating whether the incident caused customer impact. [optional]
detected datetime, none_type Timestamp when the incident was detected. [optional]
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional]
modified datetime Timestamp when the incident was last modified. [optional][readonly]
notification_handles [str] Notification handles that will be notified of the incident during update. [optional]
postmortem_id str The UUID of the postmortem object attached to the incident. [optional]
public_id int The monotonically increasing integer ID for the incident. [optional]
resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional]
time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. [optional][readonly]
time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. [optional][readonly]
time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. [optional][readonly]
time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentResponseAttributes - Datadog API Client for Python

IncidentResponseAttributes

The incident's attributes from a response.

Properties

Name Type Description Notes
title str The title of the incident, which summarizes what happened.
created datetime Timestamp when the incident was created. [optional][readonly]
customer_impact_duration int Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. [optional][readonly]
customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional]
customer_impact_scope str, none_type A summary of the impact customers experienced during the incident. [optional]
customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional]
customer_impacted bool A flag indicating whether the incident caused customer impact. [optional]
detected datetime, none_type Timestamp when the incident was detected. [optional]
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields attached to incidents. [optional]
modified datetime Timestamp when the incident was last modified. [optional][readonly]
notification_handles [str] Notification handles that will be notified of the incident during update. [optional]
postmortem_id str The UUID of the postmortem object attached to the incident. [optional]
public_id int The monotonically increasing integer ID for the incident. [optional]
resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional]
time_to_detect int The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. [optional][readonly]
time_to_internal_response int The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. [optional][readonly]
time_to_repair int The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. [optional][readonly]
time_to_resolve int The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentResponseData/index.html b/v2/IncidentResponseData/index.html index 3652c924e0..068a48b5de 100644 --- a/v2/IncidentResponseData/index.html +++ b/v2/IncidentResponseData/index.html @@ -1 +1 @@ - IncidentResponseData - Datadog API Client for Python
\ No newline at end of file + IncidentResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentResponseIncludedItem/index.html b/v2/IncidentResponseIncludedItem/index.html index c8f128d3b3..de2d0a5fd8 100644 --- a/v2/IncidentResponseIncludedItem/index.html +++ b/v2/IncidentResponseIncludedItem/index.html @@ -1 +1 @@ - IncidentResponseIncludedItem - Datadog API Client for Python

IncidentResponseIncludedItem

An object related to an incident that is included in the response.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentResponseIncludedItem - Datadog API Client for Python

IncidentResponseIncludedItem

An object related to an incident that is included in the response.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentResponseRelationships/index.html b/v2/IncidentResponseRelationships/index.html index 2e174aa49d..f8057cfc42 100644 --- a/v2/IncidentResponseRelationships/index.html +++ b/v2/IncidentResponseRelationships/index.html @@ -1 +1 @@ - IncidentResponseRelationships - Datadog API Client for Python
\ No newline at end of file + IncidentResponseRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceCreateAttributes/index.html b/v2/IncidentServiceCreateAttributes/index.html index 797e4c734a..d368a9c9d9 100644 --- a/v2/IncidentServiceCreateAttributes/index.html +++ b/v2/IncidentServiceCreateAttributes/index.html @@ -1 +1 @@ - IncidentServiceCreateAttributes - Datadog API Client for Python
\ No newline at end of file + IncidentServiceCreateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceCreateData/index.html b/v2/IncidentServiceCreateData/index.html index 681d5dff61..c04203313d 100644 --- a/v2/IncidentServiceCreateData/index.html +++ b/v2/IncidentServiceCreateData/index.html @@ -1 +1 @@ - IncidentServiceCreateData - Datadog API Client for Python
\ No newline at end of file + IncidentServiceCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceCreateRequest/index.html b/v2/IncidentServiceCreateRequest/index.html index 4d8cf4b0f8..c12af315bd 100644 --- a/v2/IncidentServiceCreateRequest/index.html +++ b/v2/IncidentServiceCreateRequest/index.html @@ -1 +1 @@ - IncidentServiceCreateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentServiceCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceIncludedItems/index.html b/v2/IncidentServiceIncludedItems/index.html index e8ccd3b5c0..b5d21274b9 100644 --- a/v2/IncidentServiceIncludedItems/index.html +++ b/v2/IncidentServiceIncludedItems/index.html @@ -1 +1 @@ - IncidentServiceIncludedItems - Datadog API Client for Python

IncidentServiceIncludedItems

An object related to an incident service which is present in the included payload.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 27, 2020
\ No newline at end of file + IncidentServiceIncludedItems - Datadog API Client for Python

IncidentServiceIncludedItems

An object related to an incident service which is present in the included payload.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentServiceRelationships/index.html b/v2/IncidentServiceRelationships/index.html index 3bc100c55a..d13a02a629 100644 --- a/v2/IncidentServiceRelationships/index.html +++ b/v2/IncidentServiceRelationships/index.html @@ -1 +1 @@ - IncidentServiceRelationships - Datadog API Client for Python
\ No newline at end of file + IncidentServiceRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceResponse/index.html b/v2/IncidentServiceResponse/index.html index 35b6eb7ec7..9dbd568330 100644 --- a/v2/IncidentServiceResponse/index.html +++ b/v2/IncidentServiceResponse/index.html @@ -1 +1 @@ - IncidentServiceResponse - Datadog API Client for Python
\ No newline at end of file + IncidentServiceResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceResponseAttributes/index.html b/v2/IncidentServiceResponseAttributes/index.html index a579755b11..de01755d87 100644 --- a/v2/IncidentServiceResponseAttributes/index.html +++ b/v2/IncidentServiceResponseAttributes/index.html @@ -1 +1 @@ - IncidentServiceResponseAttributes - Datadog API Client for Python

IncidentServiceResponseAttributes

The incident service's attributes from a response.

Properties

Name Type Description Notes
created datetime Timestamp of when the incident service was created. [optional][readonly]
modified datetime Timestamp of when the incident service was modified. [optional][readonly]
name str Name of the incident service. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 27, 2020
\ No newline at end of file + IncidentServiceResponseAttributes - Datadog API Client for Python

IncidentServiceResponseAttributes

The incident service's attributes from a response.

Properties

Name Type Description Notes
created datetime Timestamp of when the incident service was created. [optional][readonly]
modified datetime Timestamp of when the incident service was modified. [optional][readonly]
name str Name of the incident service. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentServiceResponseData/index.html b/v2/IncidentServiceResponseData/index.html index d52f42e6db..64fb1bacff 100644 --- a/v2/IncidentServiceResponseData/index.html +++ b/v2/IncidentServiceResponseData/index.html @@ -1 +1 @@ - IncidentServiceResponseData - Datadog API Client for Python
\ No newline at end of file + IncidentServiceResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceType/index.html b/v2/IncidentServiceType/index.html index a321885c20..cf10f210e4 100644 --- a/v2/IncidentServiceType/index.html +++ b/v2/IncidentServiceType/index.html @@ -1 +1 @@ - IncidentServiceType - Datadog API Client for Python

IncidentServiceType

Incident service resource type.

Properties

Name Type Description Notes
value str Incident service resource type. defaults to "services", must be one of ["services", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 12, 2021
\ No newline at end of file + IncidentServiceType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceUpdateAttributes/index.html b/v2/IncidentServiceUpdateAttributes/index.html index 9064a1480c..f6b6d2cbbe 100644 --- a/v2/IncidentServiceUpdateAttributes/index.html +++ b/v2/IncidentServiceUpdateAttributes/index.html @@ -1 +1 @@ - IncidentServiceUpdateAttributes - Datadog API Client for Python
\ No newline at end of file + IncidentServiceUpdateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceUpdateData/index.html b/v2/IncidentServiceUpdateData/index.html index bd86710f6a..8fcdcdd9bd 100644 --- a/v2/IncidentServiceUpdateData/index.html +++ b/v2/IncidentServiceUpdateData/index.html @@ -1 +1 @@ - IncidentServiceUpdateData - Datadog API Client for Python
\ No newline at end of file + IncidentServiceUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServiceUpdateRequest/index.html b/v2/IncidentServiceUpdateRequest/index.html index a350d47f1c..a7d968a8bb 100644 --- a/v2/IncidentServiceUpdateRequest/index.html +++ b/v2/IncidentServiceUpdateRequest/index.html @@ -1 +1 @@ - IncidentServiceUpdateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentServiceUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServicesApi/index.html b/v2/IncidentServicesApi/index.html index 25fcb2f3e5..d29b037599 100644 --- a/v2/IncidentServicesApi/index.html +++ b/v2/IncidentServicesApi/index.html @@ -220,4 +220,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling IncidentServicesApi->update_incident_service: %s\n" % e) -

Parameters

Name Type Description Notes
service_id str The ID of the incident service.
body IncidentServiceUpdateRequest Incident Service Payload.

Return type

IncidentServiceResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
service_id str The ID of the incident service.
body IncidentServiceUpdateRequest Incident Service Payload.

Return type

IncidentServiceResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentServicesResponse/index.html b/v2/IncidentServicesResponse/index.html index 017e4ab8ee..120dab7fd6 100644 --- a/v2/IncidentServicesResponse/index.html +++ b/v2/IncidentServicesResponse/index.html @@ -1 +1 @@ - IncidentServicesResponse - Datadog API Client for Python
\ No newline at end of file + IncidentServicesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServicesResponseMeta/index.html b/v2/IncidentServicesResponseMeta/index.html index 54e33fc903..fa734319fe 100644 --- a/v2/IncidentServicesResponseMeta/index.html +++ b/v2/IncidentServicesResponseMeta/index.html @@ -1 +1 @@ - IncidentServicesResponseMeta - Datadog API Client for Python
\ No newline at end of file + IncidentServicesResponseMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentServicesResponseMetaPagination/index.html b/v2/IncidentServicesResponseMetaPagination/index.html index 3815ec9f3c..17be50e103 100644 --- a/v2/IncidentServicesResponseMetaPagination/index.html +++ b/v2/IncidentServicesResponseMetaPagination/index.html @@ -1 +1 @@ - IncidentServicesResponseMetaPagination - Datadog API Client for Python

IncidentServicesResponseMetaPagination

Pagination properties.

Properties

Name Type Description Notes
next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional]
offset int The index of the first element in the results. [optional]
size int Maximum size of pages to return. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 27, 2020
\ No newline at end of file + IncidentServicesResponseMetaPagination - Datadog API Client for Python

IncidentServicesResponseMetaPagination

Pagination properties.

Properties

Name Type Description Notes
next_offset int The index of the first element in the next page of results. Equal to page size added to the current offset. [optional]
offset int The index of the first element in the results. [optional]
size int Maximum size of pages to return. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTeamCreateAttributes/index.html b/v2/IncidentTeamCreateAttributes/index.html index 855b72eae6..dfc727c067 100644 --- a/v2/IncidentTeamCreateAttributes/index.html +++ b/v2/IncidentTeamCreateAttributes/index.html @@ -1 +1 @@ - IncidentTeamCreateAttributes - Datadog API Client for Python
\ No newline at end of file + IncidentTeamCreateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamCreateData/index.html b/v2/IncidentTeamCreateData/index.html index 8f8d393a21..775c40430d 100644 --- a/v2/IncidentTeamCreateData/index.html +++ b/v2/IncidentTeamCreateData/index.html @@ -1 +1 @@ - IncidentTeamCreateData - Datadog API Client for Python
\ No newline at end of file + IncidentTeamCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamCreateRequest/index.html b/v2/IncidentTeamCreateRequest/index.html index 9dc91feb09..da681d74a8 100644 --- a/v2/IncidentTeamCreateRequest/index.html +++ b/v2/IncidentTeamCreateRequest/index.html @@ -1 +1 @@ - IncidentTeamCreateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentTeamCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamIncludedItems/index.html b/v2/IncidentTeamIncludedItems/index.html index 020c1b5d36..cb493ea5f3 100644 --- a/v2/IncidentTeamIncludedItems/index.html +++ b/v2/IncidentTeamIncludedItems/index.html @@ -1 +1 @@ - IncidentTeamIncludedItems - Datadog API Client for Python

IncidentTeamIncludedItems

An object related to an incident team which is present in the included payload.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 27, 2020
\ No newline at end of file + IncidentTeamIncludedItems - Datadog API Client for Python

IncidentTeamIncludedItems

An object related to an incident team which is present in the included payload.

Properties

Name Type Description Notes
attributes UserAttributes [optional]
id str ID of the user. [optional]
relationships UserResponseRelationships [optional]
type UsersType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTeamRelationships/index.html b/v2/IncidentTeamRelationships/index.html index 4e149dbe06..43de5ebd45 100644 --- a/v2/IncidentTeamRelationships/index.html +++ b/v2/IncidentTeamRelationships/index.html @@ -1 +1 @@ - IncidentTeamRelationships - Datadog API Client for Python
\ No newline at end of file + IncidentTeamRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamResponse/index.html b/v2/IncidentTeamResponse/index.html index d374818f45..2da299050d 100644 --- a/v2/IncidentTeamResponse/index.html +++ b/v2/IncidentTeamResponse/index.html @@ -1 +1 @@ - IncidentTeamResponse - Datadog API Client for Python
\ No newline at end of file + IncidentTeamResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamResponseAttributes/index.html b/v2/IncidentTeamResponseAttributes/index.html index 4e5666142d..5f83c9ff5b 100644 --- a/v2/IncidentTeamResponseAttributes/index.html +++ b/v2/IncidentTeamResponseAttributes/index.html @@ -1 +1 @@ - IncidentTeamResponseAttributes - Datadog API Client for Python

IncidentTeamResponseAttributes

The incident team's attributes from a response.

Properties

Name Type Description Notes
created datetime Timestamp of when the incident team was created. [optional][readonly]
modified datetime Timestamp of when the incident team was modified. [optional][readonly]
name str Name of the incident team. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 27, 2020
\ No newline at end of file + IncidentTeamResponseAttributes - Datadog API Client for Python

IncidentTeamResponseAttributes

The incident team's attributes from a response.

Properties

Name Type Description Notes
created datetime Timestamp of when the incident team was created. [optional][readonly]
modified datetime Timestamp of when the incident team was modified. [optional][readonly]
name str Name of the incident team. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTeamResponseData/index.html b/v2/IncidentTeamResponseData/index.html index f3a7ad059f..d768e8d1f8 100644 --- a/v2/IncidentTeamResponseData/index.html +++ b/v2/IncidentTeamResponseData/index.html @@ -1 +1 @@ - IncidentTeamResponseData - Datadog API Client for Python
\ No newline at end of file + IncidentTeamResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamType/index.html b/v2/IncidentTeamType/index.html index 22e7c3463d..6d153b42cc 100644 --- a/v2/IncidentTeamType/index.html +++ b/v2/IncidentTeamType/index.html @@ -1 +1 @@ - IncidentTeamType - Datadog API Client for Python
\ No newline at end of file + IncidentTeamType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamUpdateAttributes/index.html b/v2/IncidentTeamUpdateAttributes/index.html index 754765e47e..7f1c89fbbd 100644 --- a/v2/IncidentTeamUpdateAttributes/index.html +++ b/v2/IncidentTeamUpdateAttributes/index.html @@ -1 +1 @@ - IncidentTeamUpdateAttributes - Datadog API Client for Python
\ No newline at end of file + IncidentTeamUpdateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamUpdateData/index.html b/v2/IncidentTeamUpdateData/index.html index 72f242eddf..9c0bc51fac 100644 --- a/v2/IncidentTeamUpdateData/index.html +++ b/v2/IncidentTeamUpdateData/index.html @@ -1 +1 @@ - IncidentTeamUpdateData - Datadog API Client for Python
\ No newline at end of file + IncidentTeamUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamUpdateRequest/index.html b/v2/IncidentTeamUpdateRequest/index.html index 87b9672929..689edab629 100644 --- a/v2/IncidentTeamUpdateRequest/index.html +++ b/v2/IncidentTeamUpdateRequest/index.html @@ -1 +1 @@ - IncidentTeamUpdateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentTeamUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTeamsApi/index.html b/v2/IncidentTeamsApi/index.html index 736a97f974..c8109ae406 100644 --- a/v2/IncidentTeamsApi/index.html +++ b/v2/IncidentTeamsApi/index.html @@ -220,4 +220,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling IncidentTeamsApi->update_incident_team: %s\n" % e) -

Parameters

Name Type Description Notes
team_id str The ID of the incident team.
body IncidentTeamUpdateRequest Incident Team Payload.

Return type

IncidentTeamResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
team_id str The ID of the incident team.
body IncidentTeamUpdateRequest Incident Team Payload.

Return type

IncidentTeamResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTeamsResponse/index.html b/v2/IncidentTeamsResponse/index.html index 6ce6f32b50..0269f917e3 100644 --- a/v2/IncidentTeamsResponse/index.html +++ b/v2/IncidentTeamsResponse/index.html @@ -1 +1 @@ - IncidentTeamsResponse - Datadog API Client for Python
\ No newline at end of file + IncidentTeamsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentTimelineCellCreateAttributes/index.html b/v2/IncidentTimelineCellCreateAttributes/index.html index 566676ee0d..ccaae5caed 100644 --- a/v2/IncidentTimelineCellCreateAttributes/index.html +++ b/v2/IncidentTimelineCellCreateAttributes/index.html @@ -1 +1 @@ - IncidentTimelineCellCreateAttributes - Datadog API Client for Python

IncidentTimelineCellCreateAttributes

The timeline cell's attributes for a create request.

Properties

Name Type Description Notes
important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False
cell_type IncidentTimelineCellMarkdownContentType [optional]
content IncidentTimelineCellMarkdownCreateAttributesContent [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + IncidentTimelineCellCreateAttributes - Datadog API Client for Python

IncidentTimelineCellCreateAttributes

The timeline cell's attributes for a create request.

Properties

Name Type Description Notes
important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False
cell_type IncidentTimelineCellMarkdownContentType [optional]
content IncidentTimelineCellMarkdownCreateAttributesContent [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTimelineCellMarkdownContentType/index.html b/v2/IncidentTimelineCellMarkdownContentType/index.html index fa420c6e4e..8f77ecdf9c 100644 --- a/v2/IncidentTimelineCellMarkdownContentType/index.html +++ b/v2/IncidentTimelineCellMarkdownContentType/index.html @@ -1 +1 @@ - IncidentTimelineCellMarkdownContentType - Datadog API Client for Python

IncidentTimelineCellMarkdownContentType

Type of the Markdown timeline cell.

Properties

Name Type Description Notes
value str Type of the Markdown timeline cell. defaults to "markdown", must be one of ["markdown", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentTimelineCellMarkdownContentType - Datadog API Client for Python

IncidentTimelineCellMarkdownContentType

Type of the Markdown timeline cell.

Properties

Name Type Description Notes
value str Type of the Markdown timeline cell. defaults to "markdown", must be one of ["markdown", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTimelineCellMarkdownCreateAttributes/index.html b/v2/IncidentTimelineCellMarkdownCreateAttributes/index.html index b82796c31b..34668960df 100644 --- a/v2/IncidentTimelineCellMarkdownCreateAttributes/index.html +++ b/v2/IncidentTimelineCellMarkdownCreateAttributes/index.html @@ -1 +1 @@ - IncidentTimelineCellMarkdownCreateAttributes - Datadog API Client for Python

IncidentTimelineCellMarkdownCreateAttributes

Timeline cell data for Markdown timeline cells for a create request.

Properties

Name Type Description Notes
cell_type IncidentTimelineCellMarkdownContentType
content IncidentTimelineCellMarkdownCreateAttributesContent
important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentTimelineCellMarkdownCreateAttributes - Datadog API Client for Python

IncidentTimelineCellMarkdownCreateAttributes

Timeline cell data for Markdown timeline cells for a create request.

Properties

Name Type Description Notes
cell_type IncidentTimelineCellMarkdownContentType
content IncidentTimelineCellMarkdownCreateAttributesContent
important bool A flag indicating whether the timeline cell is important and should be highlighted. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentTimelineCellMarkdownCreateAttributesContent/index.html b/v2/IncidentTimelineCellMarkdownCreateAttributesContent/index.html index 233e657f7e..ba4728d4b5 100644 --- a/v2/IncidentTimelineCellMarkdownCreateAttributesContent/index.html +++ b/v2/IncidentTimelineCellMarkdownCreateAttributesContent/index.html @@ -1 +1 @@ - IncidentTimelineCellMarkdownCreateAttributesContent - Datadog API Client for Python
\ No newline at end of file + IncidentTimelineCellMarkdownCreateAttributesContent - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentType/index.html b/v2/IncidentType/index.html index ea8908fa02..d225b16323 100644 --- a/v2/IncidentType/index.html +++ b/v2/IncidentType/index.html @@ -1 +1 @@ - IncidentType - Datadog API Client for Python
\ No newline at end of file + IncidentType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentUpdateAttributes/index.html b/v2/IncidentUpdateAttributes/index.html index 4ba2b7a2d1..3e43d2a650 100644 --- a/v2/IncidentUpdateAttributes/index.html +++ b/v2/IncidentUpdateAttributes/index.html @@ -1 +1 @@ - IncidentUpdateAttributes - Datadog API Client for Python

IncidentUpdateAttributes

The incident's attributes for an update request.

Properties

Name Type Description Notes
customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional]
customer_impact_scope str A summary of the impact customers experienced during the incident. [optional]
customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional]
customer_impacted bool A flag indicating whether the incident caused customer impact. [optional]
detected datetime, none_type Timestamp when the incident was detected. [optional]
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional]
notification_handles [str] Notification handles that will be notified of the incident during update. [optional]
resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional]
title str The title of the incident, which summarizes what happened. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 17, 2020
\ No newline at end of file + IncidentUpdateAttributes - Datadog API Client for Python

IncidentUpdateAttributes

The incident's attributes for an update request.

Properties

Name Type Description Notes
customer_impact_end datetime, none_type Timestamp when customers were no longer impacted by the incident. [optional]
customer_impact_scope str A summary of the impact customers experienced during the incident. [optional]
customer_impact_start datetime, none_type Timestamp when customers began being impacted by the incident. [optional]
customer_impacted bool A flag indicating whether the incident caused customer impact. [optional]
detected datetime, none_type Timestamp when the incident was detected. [optional]
fields {str: (IncidentFieldAttributes,)} A condensed view of the user-defined fields for which to update selections. [optional]
notification_handles [str] Notification handles that will be notified of the incident during update. [optional]
resolved datetime, none_type Timestamp when the incident's state was set to resolved. [optional]
title str The title of the incident, which summarizes what happened. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentUpdateData/index.html b/v2/IncidentUpdateData/index.html index cbb5251404..98be0d08c9 100644 --- a/v2/IncidentUpdateData/index.html +++ b/v2/IncidentUpdateData/index.html @@ -1 +1 @@ - IncidentUpdateData - Datadog API Client for Python
\ No newline at end of file + IncidentUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentUpdateRelationships/index.html b/v2/IncidentUpdateRelationships/index.html index 6749573b4d..a50f664b9e 100644 --- a/v2/IncidentUpdateRelationships/index.html +++ b/v2/IncidentUpdateRelationships/index.html @@ -1 +1 @@ - IncidentUpdateRelationships - Datadog API Client for Python
\ No newline at end of file + IncidentUpdateRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentUpdateRequest/index.html b/v2/IncidentUpdateRequest/index.html index 775c771ec9..4eab2fc30a 100644 --- a/v2/IncidentUpdateRequest/index.html +++ b/v2/IncidentUpdateRequest/index.html @@ -1 +1 @@ - IncidentUpdateRequest - Datadog API Client for Python
\ No newline at end of file + IncidentUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/IncidentsApi/index.html b/v2/IncidentsApi/index.html index 83c5690336..071c173799 100644 --- a/v2/IncidentsApi/index.html +++ b/v2/IncidentsApi/index.html @@ -254,4 +254,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling IncidentsApi->update_incident: %s\n" % e) -

Parameters

Name Type Description Notes
incident_id str The UUID the incident.
body IncidentUpdateRequest Incident Payload.

Return type

IncidentResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
incident_id str The UUID the incident.
body IncidentUpdateRequest Incident Payload.

Return type

IncidentResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/IncidentsResponse/index.html b/v2/IncidentsResponse/index.html index 2c05bfd51f..7c47fe4599 100644 --- a/v2/IncidentsResponse/index.html +++ b/v2/IncidentsResponse/index.html @@ -1 +1 @@ - IncidentsResponse - Datadog API Client for Python
\ No newline at end of file + IncidentsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/KeyManagementApi/index.html b/v2/KeyManagementApi/index.html index 51e88e65fc..d9bd075984 100644 --- a/v2/KeyManagementApi/index.html +++ b/v2/KeyManagementApi/index.html @@ -483,4 +483,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling KeyManagementApi->update_current_user_application_key: %s\n" % e) -

Parameters

Name Type Description Notes
app_key_id str The ID of the application key.
body ApplicationKeyUpdateRequest

Return type

ApplicationKeyResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
app_key_id str The ID of the application key.
body ApplicationKeyUpdateRequest

Return type

ApplicationKeyResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/ListApplicationKeysResponse/index.html b/v2/ListApplicationKeysResponse/index.html index 2d1fea7410..55e694faa6 100644 --- a/v2/ListApplicationKeysResponse/index.html +++ b/v2/ListApplicationKeysResponse/index.html @@ -1 +1 @@ - ListApplicationKeysResponse - Datadog API Client for Python
\ No newline at end of file + ListApplicationKeysResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/Log/index.html b/v2/Log/index.html index 7149b24e4b..e477485200 100644 --- a/v2/Log/index.html +++ b/v2/Log/index.html @@ -1 +1 @@ - Log - Datadog API Client for Python
\ No newline at end of file + Log - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogAttributes/index.html b/v2/LogAttributes/index.html index 94c210c9f2..84c00a9ff5 100644 --- a/v2/LogAttributes/index.html +++ b/v2/LogAttributes/index.html @@ -1 +1 @@ - LogAttributes - Datadog API Client for Python

LogAttributes

JSON object containing all log attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional]
host str Name of the machine from where the logs are being sent. [optional]
message str The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. [optional]
service str The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. [optional]
status str Status of the message associated with your log. [optional]
tags [str] Array of tags associated with your log. [optional]
timestamp datetime Timestamp of your log. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 16, 2020
\ No newline at end of file + LogAttributes - Datadog API Client for Python

LogAttributes

JSON object containing all log attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} JSON object of attributes from your log. [optional]
host str Name of the machine from where the logs are being sent. [optional]
message str The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. [optional]
service str The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. [optional]
status str Status of the message associated with your log. [optional]
tags [str] Array of tags associated with your log. [optional]
timestamp datetime Timestamp of your log. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogType/index.html b/v2/LogType/index.html index 33a5ef8232..14954a580d 100644 --- a/v2/LogType/index.html +++ b/v2/LogType/index.html @@ -1 +1 @@ - LogType - Datadog API Client for Python
\ No newline at end of file + LogType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateBucket/index.html b/v2/LogsAggregateBucket/index.html index b01a95ef28..68933c56fd 100644 --- a/v2/LogsAggregateBucket/index.html +++ b/v2/LogsAggregateBucket/index.html @@ -1 +1 @@ - LogsAggregateBucket - Datadog API Client for Python
\ No newline at end of file + LogsAggregateBucket - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateBucketValue/index.html b/v2/LogsAggregateBucketValue/index.html index bf7362388f..110c24fdec 100644 --- a/v2/LogsAggregateBucketValue/index.html +++ b/v2/LogsAggregateBucketValue/index.html @@ -1 +1 @@ - LogsAggregateBucketValue - Datadog API Client for Python

LogsAggregateBucketValue

A bucket value, can be either a timeseries or a single value

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsAggregateBucketValue - Datadog API Client for Python

LogsAggregateBucketValue

A bucket value, can be either a timeseries or a single value

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsAggregateBucketValueTimeseries/index.html b/v2/LogsAggregateBucketValueTimeseries/index.html index 629f32477f..97dc76f478 100644 --- a/v2/LogsAggregateBucketValueTimeseries/index.html +++ b/v2/LogsAggregateBucketValueTimeseries/index.html @@ -1 +1 @@ - LogsAggregateBucketValueTimeseries - Datadog API Client for Python
\ No newline at end of file + LogsAggregateBucketValueTimeseries - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateBucketValueTimeseriesPoint/index.html b/v2/LogsAggregateBucketValueTimeseriesPoint/index.html index 9cb07c840c..41c4b682c7 100644 --- a/v2/LogsAggregateBucketValueTimeseriesPoint/index.html +++ b/v2/LogsAggregateBucketValueTimeseriesPoint/index.html @@ -1 +1 @@ - LogsAggregateBucketValueTimeseriesPoint - Datadog API Client for Python

LogsAggregateBucketValueTimeseriesPoint

A timeseries point

Properties

Name Type Description Notes
time str The time value for this point [optional]
value float The value for this point [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsAggregateBucketValueTimeseriesPoint - Datadog API Client for Python

LogsAggregateBucketValueTimeseriesPoint

A timeseries point

Properties

Name Type Description Notes
time str The time value for this point [optional]
value float The value for this point [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsAggregateRequest/index.html b/v2/LogsAggregateRequest/index.html index 407909263e..b039c10de9 100644 --- a/v2/LogsAggregateRequest/index.html +++ b/v2/LogsAggregateRequest/index.html @@ -1 +1 @@ - LogsAggregateRequest - Datadog API Client for Python

LogsAggregateRequest

The object sent with the request to retrieve a list of logs from your organization.

Properties

Name Type Description Notes
compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional]
filter LogsQueryFilter [optional]
group_by [LogsGroupBy] The rules for the group by [optional]
options LogsQueryOptions [optional]
page LogsAggregateRequestPage [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 28, 2021
\ No newline at end of file + LogsAggregateRequest - Datadog API Client for Python

LogsAggregateRequest

The object sent with the request to retrieve a list of logs from your organization.

Properties

Name Type Description Notes
compute [LogsCompute] The list of metrics or timeseries to compute for the retrieved buckets. [optional]
filter LogsQueryFilter [optional]
group_by [LogsGroupBy] The rules for the group by [optional]
options LogsQueryOptions [optional]
page LogsAggregateRequestPage [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsAggregateRequestPage/index.html b/v2/LogsAggregateRequestPage/index.html index 04c7673a27..3891b5cf20 100644 --- a/v2/LogsAggregateRequestPage/index.html +++ b/v2/LogsAggregateRequestPage/index.html @@ -1 +1 @@ - LogsAggregateRequestPage - Datadog API Client for Python
\ No newline at end of file + LogsAggregateRequestPage - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateResponse/index.html b/v2/LogsAggregateResponse/index.html index 533026fb70..c5b6d13690 100644 --- a/v2/LogsAggregateResponse/index.html +++ b/v2/LogsAggregateResponse/index.html @@ -1 +1 @@ - LogsAggregateResponse - Datadog API Client for Python
\ No newline at end of file + LogsAggregateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateResponseData/index.html b/v2/LogsAggregateResponseData/index.html index e1dc52334a..705c2f0ac2 100644 --- a/v2/LogsAggregateResponseData/index.html +++ b/v2/LogsAggregateResponseData/index.html @@ -1 +1 @@ - LogsAggregateResponseData - Datadog API Client for Python
\ No newline at end of file + LogsAggregateResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateResponseStatus/index.html b/v2/LogsAggregateResponseStatus/index.html index 91e824504c..029158ddf4 100644 --- a/v2/LogsAggregateResponseStatus/index.html +++ b/v2/LogsAggregateResponseStatus/index.html @@ -1 +1 @@ - LogsAggregateResponseStatus - Datadog API Client for Python
\ No newline at end of file + LogsAggregateResponseStatus - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateSort/index.html b/v2/LogsAggregateSort/index.html index 6733819876..52a14b6728 100644 --- a/v2/LogsAggregateSort/index.html +++ b/v2/LogsAggregateSort/index.html @@ -1 +1 @@ - LogsAggregateSort - Datadog API Client for Python
\ No newline at end of file + LogsAggregateSort - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsAggregateSortType/index.html b/v2/LogsAggregateSortType/index.html index 67ca4d2653..43f66c248c 100644 --- a/v2/LogsAggregateSortType/index.html +++ b/v2/LogsAggregateSortType/index.html @@ -1 +1 @@ - LogsAggregateSortType - Datadog API Client for Python

LogsAggregateSortType

The type of sorting algorithm

Properties

Name Type Description Notes
value str The type of sorting algorithm defaults to "alphabetical", must be one of ["alphabetical", "measure", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsAggregateSortType - Datadog API Client for Python

LogsAggregateSortType

The type of sorting algorithm

Properties

Name Type Description Notes
value str The type of sorting algorithm defaults to "alphabetical", must be one of ["alphabetical", "measure", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsAggregationFunction/index.html b/v2/LogsAggregationFunction/index.html index 40b6c45e5a..73d7009656 100644 --- a/v2/LogsAggregationFunction/index.html +++ b/v2/LogsAggregationFunction/index.html @@ -1 +1 @@ - LogsAggregationFunction - Datadog API Client for Python

LogsAggregationFunction

An aggregation function

Properties

Name Type Description Notes
value str An aggregation function must be one of ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsAggregationFunction - Datadog API Client for Python

LogsAggregationFunction

An aggregation function

Properties

Name Type Description Notes
value str An aggregation function must be one of ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsApi/index.html b/v2/LogsApi/index.html index 8c14ea85ee..9871c55f43 100644 --- a/v2/LogsApi/index.html +++ b/v2/LogsApi/index.html @@ -159,4 +159,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsApi->list_logs_get: %s\n" % e) -

Parameters

Name Type Description Notes
filter_query str Search query following logs syntax. [optional]
filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional]
filter_from datetime Minimum timestamp for requested logs. [optional]
filter_to datetime Maximum timestamp for requested logs. [optional]
sort LogsSort Order of logs in results. [optional]
page_cursor str List following results with a cursor provided in the previous query. [optional]
page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10

Return type

LogsListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Not Authorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
filter_query str Search query following logs syntax. [optional]
filter_index str For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes [optional]
filter_from datetime Minimum timestamp for requested logs. [optional]
filter_to datetime Maximum timestamp for requested logs. [optional]
sort LogsSort Order of logs in results. [optional]
page_cursor str List following results with a cursor provided in the previous query. [optional]
page_limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10

Return type

LogsListResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Not Authorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchive/index.html b/v2/LogsArchive/index.html index 6c56ee1fd0..5cde715231 100644 --- a/v2/LogsArchive/index.html +++ b/v2/LogsArchive/index.html @@ -1 +1 @@ - LogsArchive - Datadog API Client for Python
\ No newline at end of file + LogsArchive - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveAttributes/index.html b/v2/LogsArchiveAttributes/index.html index 4b23af8a99..e954bff623 100644 --- a/v2/LogsArchiveAttributes/index.html +++ b/v2/LogsArchiveAttributes/index.html @@ -1 +1 @@ - LogsArchiveAttributes - Datadog API Client for Python

LogsArchiveAttributes

The attributes associated with the archive.

Properties

Name Type Description Notes
destination LogsArchiveDestination
name str The archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
include_tags bool To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. [optional] if omitted the server will use the default value of False
rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional]
state LogsArchiveState [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 22, 2020
\ No newline at end of file + LogsArchiveAttributes - Datadog API Client for Python

LogsArchiveAttributes

The attributes associated with the archive.

Properties

Name Type Description Notes
destination LogsArchiveDestination
name str The archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
include_tags bool To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. [optional] if omitted the server will use the default value of False
rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional]
state LogsArchiveState [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveCreateRequest/index.html b/v2/LogsArchiveCreateRequest/index.html index 72f9b95a04..296f0db383 100644 --- a/v2/LogsArchiveCreateRequest/index.html +++ b/v2/LogsArchiveCreateRequest/index.html @@ -1 +1 @@ - LogsArchiveCreateRequest - Datadog API Client for Python
\ No newline at end of file + LogsArchiveCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveCreateRequestAttributes/index.html b/v2/LogsArchiveCreateRequestAttributes/index.html index a6a77e3413..54b056f4ba 100644 --- a/v2/LogsArchiveCreateRequestAttributes/index.html +++ b/v2/LogsArchiveCreateRequestAttributes/index.html @@ -1 +1 @@ - LogsArchiveCreateRequestAttributes - Datadog API Client for Python

LogsArchiveCreateRequestAttributes

The attributes associated with the archive.

Properties

Name Type Description Notes
destination LogsArchiveCreateRequestDestination
name str The archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
include_tags bool To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. [optional] if omitted the server will use the default value of False
rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 22, 2020
\ No newline at end of file + LogsArchiveCreateRequestAttributes - Datadog API Client for Python

LogsArchiveCreateRequestAttributes

The attributes associated with the archive.

Properties

Name Type Description Notes
destination LogsArchiveCreateRequestDestination
name str The archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
include_tags bool To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. [optional] if omitted the server will use the default value of False
rehydration_tags [str] An array of tags to add to rehydrated logs from an archive. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveCreateRequestDefinition/index.html b/v2/LogsArchiveCreateRequestDefinition/index.html index e843ac8e75..f8456279f8 100644 --- a/v2/LogsArchiveCreateRequestDefinition/index.html +++ b/v2/LogsArchiveCreateRequestDefinition/index.html @@ -1 +1 @@ - LogsArchiveCreateRequestDefinition - Datadog API Client for Python
\ No newline at end of file + LogsArchiveCreateRequestDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveCreateRequestDestination/index.html b/v2/LogsArchiveCreateRequestDestination/index.html index bf44454886..ab98729002 100644 --- a/v2/LogsArchiveCreateRequestDestination/index.html +++ b/v2/LogsArchiveCreateRequestDestination/index.html @@ -1 +1 @@ - LogsArchiveCreateRequestDestination - Datadog API Client for Python

LogsArchiveCreateRequestDestination

An archive's destination.

Properties

Name Type Description Notes
path str The archive path. [optional]
region str The region where the archive will be stored. [optional]
container str The container where the archive will be stored. [optional]
integration LogsArchiveIntegrationS3 [optional]
storage_account str The associated storage account. [optional]
type LogsArchiveDestinationS3Type [optional]
bucket str The bucket where the archive will be stored. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + LogsArchiveCreateRequestDestination - Datadog API Client for Python

LogsArchiveCreateRequestDestination

An archive's destination.

Properties

Name Type Description Notes
path str The archive path. [optional]
region str The region where the archive will be stored. [optional]
container str The container where the archive will be stored. [optional]
integration LogsArchiveIntegrationS3 [optional]
storage_account str The associated storage account. [optional]
type LogsArchiveDestinationS3Type [optional]
bucket str The bucket where the archive will be stored. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveDefinition/index.html b/v2/LogsArchiveDefinition/index.html index f019f501e4..09f814076d 100644 --- a/v2/LogsArchiveDefinition/index.html +++ b/v2/LogsArchiveDefinition/index.html @@ -1 +1 @@ - LogsArchiveDefinition - Datadog API Client for Python
\ No newline at end of file + LogsArchiveDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveDestination/index.html b/v2/LogsArchiveDestination/index.html index 31aba3f742..0bfc212128 100644 --- a/v2/LogsArchiveDestination/index.html +++ b/v2/LogsArchiveDestination/index.html @@ -1 +1 @@ - LogsArchiveDestination - Datadog API Client for Python

LogsArchiveDestination

An archive's destination.

Properties

Name Type Description Notes
path str The archive path. [optional]
region str The region where the archive will be stored. [optional]
container str The container where the archive will be stored. [optional]
integration LogsArchiveIntegrationS3 [optional]
storage_account str The associated storage account. [optional]
type LogsArchiveDestinationS3Type [optional]
bucket str The bucket where the archive will be stored. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 8, 2021
\ No newline at end of file + LogsArchiveDestination - Datadog API Client for Python

LogsArchiveDestination

An archive's destination.

Properties

Name Type Description Notes
path str The archive path. [optional]
region str The region where the archive will be stored. [optional]
container str The container where the archive will be stored. [optional]
integration LogsArchiveIntegrationS3 [optional]
storage_account str The associated storage account. [optional]
type LogsArchiveDestinationS3Type [optional]
bucket str The bucket where the archive will be stored. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationAzure/index.html b/v2/LogsArchiveDestinationAzure/index.html index ed7a0a2852..db10d455a1 100644 --- a/v2/LogsArchiveDestinationAzure/index.html +++ b/v2/LogsArchiveDestinationAzure/index.html @@ -1 +1 @@ - LogsArchiveDestinationAzure - Datadog API Client for Python
\ No newline at end of file + LogsArchiveDestinationAzure - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationAzureType/index.html b/v2/LogsArchiveDestinationAzureType/index.html index 4670ce663c..1249b1d4c2 100644 --- a/v2/LogsArchiveDestinationAzureType/index.html +++ b/v2/LogsArchiveDestinationAzureType/index.html @@ -1 +1 @@ - LogsArchiveDestinationAzureType - Datadog API Client for Python

LogsArchiveDestinationAzureType

Type of the Azure archive destination.

Properties

Name Type Description Notes
value str Type of the Azure archive destination. defaults to "azure", must be one of ["azure", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsArchiveDestinationAzureType - Datadog API Client for Python

LogsArchiveDestinationAzureType

Type of the Azure archive destination.

Properties

Name Type Description Notes
value str Type of the Azure archive destination. defaults to "azure", must be one of ["azure", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationGCS/index.html b/v2/LogsArchiveDestinationGCS/index.html index f23a1a157e..37594b85be 100644 --- a/v2/LogsArchiveDestinationGCS/index.html +++ b/v2/LogsArchiveDestinationGCS/index.html @@ -1 +1 @@ - LogsArchiveDestinationGCS - Datadog API Client for Python
\ No newline at end of file + LogsArchiveDestinationGCS - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationGCSType/index.html b/v2/LogsArchiveDestinationGCSType/index.html index ff486a43b7..6d55cac18c 100644 --- a/v2/LogsArchiveDestinationGCSType/index.html +++ b/v2/LogsArchiveDestinationGCSType/index.html @@ -1 +1 @@ - LogsArchiveDestinationGCSType - Datadog API Client for Python

LogsArchiveDestinationGCSType

Type of the GCS archive destination.

Properties

Name Type Description Notes
value str Type of the GCS archive destination. defaults to "gcs", must be one of ["gcs", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsArchiveDestinationGCSType - Datadog API Client for Python

LogsArchiveDestinationGCSType

Type of the GCS archive destination.

Properties

Name Type Description Notes
value str Type of the GCS archive destination. defaults to "gcs", must be one of ["gcs", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationS3/index.html b/v2/LogsArchiveDestinationS3/index.html index 3cd4cc54b6..00a7094010 100644 --- a/v2/LogsArchiveDestinationS3/index.html +++ b/v2/LogsArchiveDestinationS3/index.html @@ -1 +1 @@ - LogsArchiveDestinationS3 - Datadog API Client for Python
\ No newline at end of file + LogsArchiveDestinationS3 - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveDestinationS3Type/index.html b/v2/LogsArchiveDestinationS3Type/index.html index 8856d5c9bf..06a11f5366 100644 --- a/v2/LogsArchiveDestinationS3Type/index.html +++ b/v2/LogsArchiveDestinationS3Type/index.html @@ -1 +1 @@ - LogsArchiveDestinationS3Type - Datadog API Client for Python

LogsArchiveDestinationS3Type

Type of the S3 archive destination.

Properties

Name Type Description Notes
value str Type of the S3 archive destination. defaults to "s3", must be one of ["s3", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsArchiveDestinationS3Type - Datadog API Client for Python

LogsArchiveDestinationS3Type

Type of the S3 archive destination.

Properties

Name Type Description Notes
value str Type of the S3 archive destination. defaults to "s3", must be one of ["s3", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveIntegrationAzure/index.html b/v2/LogsArchiveIntegrationAzure/index.html index 4d4a168588..e5d0a90008 100644 --- a/v2/LogsArchiveIntegrationAzure/index.html +++ b/v2/LogsArchiveIntegrationAzure/index.html @@ -1 +1 @@ - LogsArchiveIntegrationAzure - Datadog API Client for Python
\ No newline at end of file + LogsArchiveIntegrationAzure - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveIntegrationGCS/index.html b/v2/LogsArchiveIntegrationGCS/index.html index 9fc7434a3b..2cda134ce8 100644 --- a/v2/LogsArchiveIntegrationGCS/index.html +++ b/v2/LogsArchiveIntegrationGCS/index.html @@ -1 +1 @@ - LogsArchiveIntegrationGCS - Datadog API Client for Python
\ No newline at end of file + LogsArchiveIntegrationGCS - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveIntegrationS3/index.html b/v2/LogsArchiveIntegrationS3/index.html index 088935b1d6..18a356bede 100644 --- a/v2/LogsArchiveIntegrationS3/index.html +++ b/v2/LogsArchiveIntegrationS3/index.html @@ -1 +1 @@ - LogsArchiveIntegrationS3 - Datadog API Client for Python

LogsArchiveIntegrationS3

The S3 Archive's integration destination.

Properties

Name Type Description Notes
account_id str The account ID for the integration.
role_name str The path of the integration.

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsArchiveIntegrationS3 - Datadog API Client for Python

LogsArchiveIntegrationS3

The S3 Archive's integration destination.

Properties

Name Type Description Notes
account_id str The account ID for the integration.
role_name str The path of the integration.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveOrder/index.html b/v2/LogsArchiveOrder/index.html index 7dc827fe4e..2b42f7f1f4 100644 --- a/v2/LogsArchiveOrder/index.html +++ b/v2/LogsArchiveOrder/index.html @@ -1 +1 @@ - LogsArchiveOrder - Datadog API Client for Python
\ No newline at end of file + LogsArchiveOrder - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveOrderAttributes/index.html b/v2/LogsArchiveOrderAttributes/index.html index 2da44e249f..43c97d9c15 100644 --- a/v2/LogsArchiveOrderAttributes/index.html +++ b/v2/LogsArchiveOrderAttributes/index.html @@ -1 +1 @@ - LogsArchiveOrderAttributes - Datadog API Client for Python

LogsArchiveOrderAttributes

The attributes associated with the archive order.

Properties

Name Type Description Notes
archive_ids [str] An ordered array of `<ARCHIVE_ID>` strings, the order of archive IDs in the array define the overall archives order for Datadog.

[Back to Model list] [Back to API list] [Back to README]

Last update: October 5, 2020
\ No newline at end of file + LogsArchiveOrderAttributes - Datadog API Client for Python

LogsArchiveOrderAttributes

The attributes associated with the archive order.

Properties

Name Type Description Notes
archive_ids [str] An ordered array of `<ARCHIVE_ID>` strings, the order of archive IDs in the array define the overall archives order for Datadog.

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveOrderDefinition/index.html b/v2/LogsArchiveOrderDefinition/index.html index ce6b6eb881..73344eae0b 100644 --- a/v2/LogsArchiveOrderDefinition/index.html +++ b/v2/LogsArchiveOrderDefinition/index.html @@ -1 +1 @@ - LogsArchiveOrderDefinition - Datadog API Client for Python
\ No newline at end of file + LogsArchiveOrderDefinition - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchiveOrderDefinitionType/index.html b/v2/LogsArchiveOrderDefinitionType/index.html index 1f45db8e5a..9899884849 100644 --- a/v2/LogsArchiveOrderDefinitionType/index.html +++ b/v2/LogsArchiveOrderDefinitionType/index.html @@ -1 +1 @@ - LogsArchiveOrderDefinitionType - Datadog API Client for Python

LogsArchiveOrderDefinitionType

Type of the archive order definition.

Properties

Name Type Description Notes
value str Type of the archive order definition. defaults to "archive_order", must be one of ["archive_order", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + LogsArchiveOrderDefinitionType - Datadog API Client for Python

LogsArchiveOrderDefinitionType

Type of the archive order definition.

Properties

Name Type Description Notes
value str Type of the archive order definition. defaults to "archive_order", must be one of ["archive_order", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchiveState/index.html b/v2/LogsArchiveState/index.html index 0fc263550f..62b495beba 100644 --- a/v2/LogsArchiveState/index.html +++ b/v2/LogsArchiveState/index.html @@ -1 +1 @@ - LogsArchiveState - Datadog API Client for Python

LogsArchiveState

The state of the archive.

Properties

Name Type Description Notes
value str The state of the archive. must be one of ["UNKNOWN", "WORKING", "FAILING", "WORKING_AUTH_LEGACY", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsArchiveState - Datadog API Client for Python

LogsArchiveState

The state of the archive.

Properties

Name Type Description Notes
value str The state of the archive. must be one of ["UNKNOWN", "WORKING", "FAILING", "WORKING_AUTH_LEGACY", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsArchives/index.html b/v2/LogsArchives/index.html index ce09dd60c3..2c55a686de 100644 --- a/v2/LogsArchives/index.html +++ b/v2/LogsArchives/index.html @@ -1 +1 @@ - LogsArchives - Datadog API Client for Python
\ No newline at end of file + LogsArchives - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsArchivesApi/index.html b/v2/LogsArchivesApi/index.html index 323345888c..71617b434e 100644 --- a/v2/LogsArchivesApi/index.html +++ b/v2/LogsArchivesApi/index.html @@ -355,4 +355,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsArchivesApi->update_logs_archive_order: %s\n" % e) -

Parameters

Name Type Description Notes
body LogsArchiveOrder An object containing the new ordered list of archive IDs.

Return type

LogsArchiveOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
body LogsArchiveOrder An object containing the new ordered list of archive IDs.

Return type

LogsArchiveOrder

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsCompute/index.html b/v2/LogsCompute/index.html index 2a23447286..8fbc52fc4b 100644 --- a/v2/LogsCompute/index.html +++ b/v2/LogsCompute/index.html @@ -1 +1 @@ - LogsCompute - Datadog API Client for Python
\ No newline at end of file + LogsCompute - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsComputeType/index.html b/v2/LogsComputeType/index.html index 75b10ff55c..b544750e12 100644 --- a/v2/LogsComputeType/index.html +++ b/v2/LogsComputeType/index.html @@ -1 +1 @@ - LogsComputeType - Datadog API Client for Python
\ No newline at end of file + LogsComputeType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsGroupBy/index.html b/v2/LogsGroupBy/index.html index d60ad74439..59d2306930 100644 --- a/v2/LogsGroupBy/index.html +++ b/v2/LogsGroupBy/index.html @@ -1 +1 @@ - LogsGroupBy - Datadog API Client for Python
\ No newline at end of file + LogsGroupBy - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsGroupByHistogram/index.html b/v2/LogsGroupByHistogram/index.html index 17d1d14e52..f2244a7d52 100644 --- a/v2/LogsGroupByHistogram/index.html +++ b/v2/LogsGroupByHistogram/index.html @@ -1 +1 @@ - LogsGroupByHistogram - Datadog API Client for Python

LogsGroupByHistogram

Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.

Properties

Name Type Description Notes
interval float The bin size of the histogram buckets
max float The maximum value for the measure used in the histogram (values greater than this one are filtered out)
min float The minimum value for the measure used in the histogram (values smaller than this one are filtered out)

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGroupByHistogram - Datadog API Client for Python

LogsGroupByHistogram

Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.

Properties

Name Type Description Notes
interval float The bin size of the histogram buckets
max float The maximum value for the measure used in the histogram (values greater than this one are filtered out)
min float The minimum value for the measure used in the histogram (values smaller than this one are filtered out)

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsGroupByMissing/index.html b/v2/LogsGroupByMissing/index.html index 1f4498a4d6..223eada365 100644 --- a/v2/LogsGroupByMissing/index.html +++ b/v2/LogsGroupByMissing/index.html @@ -1 +1 @@ - LogsGroupByMissing - Datadog API Client for Python

LogsGroupByMissing

The value to use for logs that don't have the facet used to group by

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGroupByMissing - Datadog API Client for Python

LogsGroupByMissing

The value to use for logs that don't have the facet used to group by

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsGroupByTotal/index.html b/v2/LogsGroupByTotal/index.html index 01cd63ba13..6fa139b16a 100644 --- a/v2/LogsGroupByTotal/index.html +++ b/v2/LogsGroupByTotal/index.html @@ -1 +1 @@ - LogsGroupByTotal - Datadog API Client for Python

LogsGroupByTotal

A resulting object to put the given computes in over all the matching records.

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsGroupByTotal - Datadog API Client for Python

LogsGroupByTotal

A resulting object to put the given computes in over all the matching records.

Properties

Name Type Description Notes
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsListRequest/index.html b/v2/LogsListRequest/index.html index ce1343f66a..4e1af1d958 100644 --- a/v2/LogsListRequest/index.html +++ b/v2/LogsListRequest/index.html @@ -1 +1 @@ - LogsListRequest - Datadog API Client for Python
\ No newline at end of file + LogsListRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsListRequestPage/index.html b/v2/LogsListRequestPage/index.html index cf691480c5..c6adb4a1fb 100644 --- a/v2/LogsListRequestPage/index.html +++ b/v2/LogsListRequestPage/index.html @@ -1 +1 @@ - LogsListRequestPage - Datadog API Client for Python

LogsListRequestPage

Paging attributes for listing logs.

Properties

Name Type Description Notes
cursor str List following results with a cursor provided in the previous query. [optional]
limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsListRequestPage - Datadog API Client for Python

LogsListRequestPage

Paging attributes for listing logs.

Properties

Name Type Description Notes
cursor str List following results with a cursor provided in the previous query. [optional]
limit int Maximum number of logs in the response. [optional] if omitted the server will use the default value of 10

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsListResponse/index.html b/v2/LogsListResponse/index.html index 68917c8b68..e0845c33da 100644 --- a/v2/LogsListResponse/index.html +++ b/v2/LogsListResponse/index.html @@ -1 +1 @@ - LogsListResponse - Datadog API Client for Python
\ No newline at end of file + LogsListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsListResponseLinks/index.html b/v2/LogsListResponseLinks/index.html index e95d6dceb0..68eb83b3bb 100644 --- a/v2/LogsListResponseLinks/index.html +++ b/v2/LogsListResponseLinks/index.html @@ -1 +1 @@ - LogsListResponseLinks - Datadog API Client for Python

LogsListResponseLinks

Links attributes.

Properties

Name Type Description Notes
next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsListResponseLinks - Datadog API Client for Python

LogsListResponseLinks

Links attributes.

Properties

Name Type Description Notes
next str Link for the next set of results. Note that the request can also be made using the POST endpoint. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricCompute/index.html b/v2/LogsMetricCompute/index.html index 9fb30861d0..47725f3089 100644 --- a/v2/LogsMetricCompute/index.html +++ b/v2/LogsMetricCompute/index.html @@ -1 +1 @@ - LogsMetricCompute - Datadog API Client for Python
\ No newline at end of file + LogsMetricCompute - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricComputeAggregationType/index.html b/v2/LogsMetricComputeAggregationType/index.html index 0e8d3c7b85..706d382633 100644 --- a/v2/LogsMetricComputeAggregationType/index.html +++ b/v2/LogsMetricComputeAggregationType/index.html @@ -1 +1 @@ - LogsMetricComputeAggregationType - Datadog API Client for Python

LogsMetricComputeAggregationType

The type of aggregation to use.

Properties

Name Type Description Notes
value str The type of aggregation to use. must be one of ["count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricComputeAggregationType - Datadog API Client for Python

LogsMetricComputeAggregationType

The type of aggregation to use.

Properties

Name Type Description Notes
value str The type of aggregation to use. must be one of ["count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricCreateAttributes/index.html b/v2/LogsMetricCreateAttributes/index.html index a4d7c0c40b..0da4aa4f74 100644 --- a/v2/LogsMetricCreateAttributes/index.html +++ b/v2/LogsMetricCreateAttributes/index.html @@ -1 +1 @@ - LogsMetricCreateAttributes - Datadog API Client for Python
\ No newline at end of file + LogsMetricCreateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricCreateData/index.html b/v2/LogsMetricCreateData/index.html index 6d3d8f8fc8..47c0f694fb 100644 --- a/v2/LogsMetricCreateData/index.html +++ b/v2/LogsMetricCreateData/index.html @@ -1 +1 @@ - LogsMetricCreateData - Datadog API Client for Python
\ No newline at end of file + LogsMetricCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricCreateRequest/index.html b/v2/LogsMetricCreateRequest/index.html index 673453578a..8763f1511c 100644 --- a/v2/LogsMetricCreateRequest/index.html +++ b/v2/LogsMetricCreateRequest/index.html @@ -1 +1 @@ - LogsMetricCreateRequest - Datadog API Client for Python
\ No newline at end of file + LogsMetricCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricFilter/index.html b/v2/LogsMetricFilter/index.html index 43302213ec..5ca5dcd77a 100644 --- a/v2/LogsMetricFilter/index.html +++ b/v2/LogsMetricFilter/index.html @@ -1 +1 @@ - LogsMetricFilter - Datadog API Client for Python

LogsMetricFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Properties

Name Type Description Notes
query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of "*"

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricFilter - Datadog API Client for Python

LogsMetricFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Properties

Name Type Description Notes
query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of "*"

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricGroupBy/index.html b/v2/LogsMetricGroupBy/index.html index fc472dad37..99fb049d35 100644 --- a/v2/LogsMetricGroupBy/index.html +++ b/v2/LogsMetricGroupBy/index.html @@ -1 +1 @@ - LogsMetricGroupBy - Datadog API Client for Python

LogsMetricGroupBy

A group by rule.

Properties

Name Type Description Notes
path str The path to the value the log-based metric will be aggregated over.
tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricGroupBy - Datadog API Client for Python

LogsMetricGroupBy

A group by rule.

Properties

Name Type Description Notes
path str The path to the value the log-based metric will be aggregated over.
tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricResponse/index.html b/v2/LogsMetricResponse/index.html index dc103d6408..ca07462f27 100644 --- a/v2/LogsMetricResponse/index.html +++ b/v2/LogsMetricResponse/index.html @@ -1 +1 @@ - LogsMetricResponse - Datadog API Client for Python
\ No newline at end of file + LogsMetricResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricResponseAttributes/index.html b/v2/LogsMetricResponseAttributes/index.html index e272ec9d69..1380398af9 100644 --- a/v2/LogsMetricResponseAttributes/index.html +++ b/v2/LogsMetricResponseAttributes/index.html @@ -1 +1 @@ - LogsMetricResponseAttributes - Datadog API Client for Python
\ No newline at end of file + LogsMetricResponseAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricResponseCompute/index.html b/v2/LogsMetricResponseCompute/index.html index 1b64e71f20..2fe513b27c 100644 --- a/v2/LogsMetricResponseCompute/index.html +++ b/v2/LogsMetricResponseCompute/index.html @@ -1 +1 @@ - LogsMetricResponseCompute - Datadog API Client for Python
\ No newline at end of file + LogsMetricResponseCompute - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricResponseComputeAggregationType/index.html b/v2/LogsMetricResponseComputeAggregationType/index.html index 99686cc444..30030371ab 100644 --- a/v2/LogsMetricResponseComputeAggregationType/index.html +++ b/v2/LogsMetricResponseComputeAggregationType/index.html @@ -1 +1 @@ - LogsMetricResponseComputeAggregationType - Datadog API Client for Python

LogsMetricResponseComputeAggregationType

The type of aggregation to use.

Properties

Name Type Description Notes
value str The type of aggregation to use. must be one of ["count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricResponseComputeAggregationType - Datadog API Client for Python

LogsMetricResponseComputeAggregationType

The type of aggregation to use.

Properties

Name Type Description Notes
value str The type of aggregation to use. must be one of ["count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricResponseData/index.html b/v2/LogsMetricResponseData/index.html index 27ca44c5ab..25a0999d89 100644 --- a/v2/LogsMetricResponseData/index.html +++ b/v2/LogsMetricResponseData/index.html @@ -1 +1 @@ - LogsMetricResponseData - Datadog API Client for Python
\ No newline at end of file + LogsMetricResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricResponseFilter/index.html b/v2/LogsMetricResponseFilter/index.html index 24e6810292..e3a245a0fe 100644 --- a/v2/LogsMetricResponseFilter/index.html +++ b/v2/LogsMetricResponseFilter/index.html @@ -1 +1 @@ - LogsMetricResponseFilter - Datadog API Client for Python

LogsMetricResponseFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Properties

Name Type Description Notes
query str The search query - following the log search syntax. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricResponseFilter - Datadog API Client for Python

LogsMetricResponseFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Properties

Name Type Description Notes
query str The search query - following the log search syntax. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricResponseGroupBy/index.html b/v2/LogsMetricResponseGroupBy/index.html index cddd0b154a..6d74638239 100644 --- a/v2/LogsMetricResponseGroupBy/index.html +++ b/v2/LogsMetricResponseGroupBy/index.html @@ -1 +1 @@ - LogsMetricResponseGroupBy - Datadog API Client for Python

LogsMetricResponseGroupBy

A group by rule.

Properties

Name Type Description Notes
path str The path to the value the log-based metric will be aggregated over. [optional]
tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricResponseGroupBy - Datadog API Client for Python

LogsMetricResponseGroupBy

A group by rule.

Properties

Name Type Description Notes
path str The path to the value the log-based metric will be aggregated over. [optional]
tag_name str Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricType/index.html b/v2/LogsMetricType/index.html index 528d834e5e..78e85c661d 100644 --- a/v2/LogsMetricType/index.html +++ b/v2/LogsMetricType/index.html @@ -1 +1 @@ - LogsMetricType - Datadog API Client for Python

LogsMetricType

The type of the resource. The value should always be logs_metrics.

Properties

Name Type Description Notes
value str The type of the resource. The value should always be logs_metrics. defaults to "logs_metrics", must be one of ["logs_metrics", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 22, 2020
\ No newline at end of file + LogsMetricType - Datadog API Client for Python

LogsMetricType

The type of the resource. The value should always be logs_metrics.

Properties

Name Type Description Notes
value str The type of the resource. The value should always be logs_metrics. defaults to "logs_metrics", must be one of ["logs_metrics", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricUpdateAttributes/index.html b/v2/LogsMetricUpdateAttributes/index.html index b5feeda7bc..be81a59aa8 100644 --- a/v2/LogsMetricUpdateAttributes/index.html +++ b/v2/LogsMetricUpdateAttributes/index.html @@ -1 +1 @@ - LogsMetricUpdateAttributes - Datadog API Client for Python
\ No newline at end of file + LogsMetricUpdateAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricUpdateData/index.html b/v2/LogsMetricUpdateData/index.html index 5c5c082ef6..338cc6913c 100644 --- a/v2/LogsMetricUpdateData/index.html +++ b/v2/LogsMetricUpdateData/index.html @@ -1 +1 @@ - LogsMetricUpdateData - Datadog API Client for Python
\ No newline at end of file + LogsMetricUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricUpdateRequest/index.html b/v2/LogsMetricUpdateRequest/index.html index b20439e540..f1d92b14c2 100644 --- a/v2/LogsMetricUpdateRequest/index.html +++ b/v2/LogsMetricUpdateRequest/index.html @@ -1 +1 @@ - LogsMetricUpdateRequest - Datadog API Client for Python
\ No newline at end of file + LogsMetricUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsMetricsApi/index.html b/v2/LogsMetricsApi/index.html index 4caeae1163..15fff18e01 100644 --- a/v2/LogsMetricsApi/index.html +++ b/v2/LogsMetricsApi/index.html @@ -192,4 +192,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling LogsMetricsApi->update_logs_metric: %s\n" % e) -

Parameters

Name Type Description Notes
metric_id str The name of the log-based metric.
body LogsMetricUpdateRequest New definition of the log-based metric.

Return type

LogsMetricResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Not Authorized -
404 Not Found -
429 Too many requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
metric_id str The name of the log-based metric.
body LogsMetricUpdateRequest New definition of the log-based metric.

Return type

LogsMetricResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Not Authorized -
404 Not Found -
429 Too many requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsMetricsResponse/index.html b/v2/LogsMetricsResponse/index.html index 6db2c1712d..1cd4954cd2 100644 --- a/v2/LogsMetricsResponse/index.html +++ b/v2/LogsMetricsResponse/index.html @@ -1 +1 @@ - LogsMetricsResponse - Datadog API Client for Python
\ No newline at end of file + LogsMetricsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsQueryFilter/index.html b/v2/LogsQueryFilter/index.html index 3a9b7eba64..12dd9c41d0 100644 --- a/v2/LogsQueryFilter/index.html +++ b/v2/LogsQueryFilter/index.html @@ -1 +1 @@ - LogsQueryFilter - Datadog API Client for Python

LogsQueryFilter

The search and filter query settings

Properties

Name Type Description Notes
_from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of "now-15m"
indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of ["*"]
query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of "*"
to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of "now"

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsQueryFilter - Datadog API Client for Python

LogsQueryFilter

The search and filter query settings

Properties

Name Type Description Notes
_from str The minimum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of "now-15m"
indexes [str] For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. [optional] if omitted the server will use the default value of ["*"]
query str The search query - following the log search syntax. [optional] if omitted the server will use the default value of "*"
to str The maximum time for the requested logs, supports date math and regular timestamps [optional] if omitted the server will use the default value of "now"

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsQueryOptions/index.html b/v2/LogsQueryOptions/index.html index 00d9956ace..6656a8173b 100644 --- a/v2/LogsQueryOptions/index.html +++ b/v2/LogsQueryOptions/index.html @@ -1 +1 @@ - LogsQueryOptions - Datadog API Client for Python

LogsQueryOptions

Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.

Properties

Name Type Description Notes
time_offset int The time offset (in seconds) to apply to the query. [optional]
timezone str The timezone can be specified both as an offset, for example: \"UTC+03:00\". [optional] if omitted the server will use the default value of "UTC"

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsQueryOptions - Datadog API Client for Python

LogsQueryOptions

Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.

Properties

Name Type Description Notes
time_offset int The time offset (in seconds) to apply to the query. [optional]
timezone str The timezone can be specified both as an offset, for example: \"UTC+03:00\". [optional] if omitted the server will use the default value of "UTC"

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsResponseMetadata/index.html b/v2/LogsResponseMetadata/index.html index 7a9369f0fd..577a2288c2 100644 --- a/v2/LogsResponseMetadata/index.html +++ b/v2/LogsResponseMetadata/index.html @@ -1 +1 @@ - LogsResponseMetadata - Datadog API Client for Python

LogsResponseMetadata

The metadata associated with a request

Properties

Name Type Description Notes
elapsed int The time elapsed in milliseconds [optional]
page LogsResponseMetadataPage [optional]
request_id str The identifier of the request [optional]
status LogsAggregateResponseStatus [optional]
warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsResponseMetadata - Datadog API Client for Python

LogsResponseMetadata

The metadata associated with a request

Properties

Name Type Description Notes
elapsed int The time elapsed in milliseconds [optional]
page LogsResponseMetadataPage [optional]
request_id str The identifier of the request [optional]
status LogsAggregateResponseStatus [optional]
warnings [LogsWarning] A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsResponseMetadataPage/index.html b/v2/LogsResponseMetadataPage/index.html index 4b1e2fd29f..ecd9230cc8 100644 --- a/v2/LogsResponseMetadataPage/index.html +++ b/v2/LogsResponseMetadataPage/index.html @@ -1 +1 @@ - LogsResponseMetadataPage - Datadog API Client for Python

LogsResponseMetadataPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor to use to get the next results, if any. To make the next request, use the same. parameters with the addition of the `page[cursor]`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsResponseMetadataPage - Datadog API Client for Python

LogsResponseMetadataPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor to use to get the next results, if any. To make the next request, use the same. parameters with the addition of the `page[cursor]`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/LogsSort/index.html b/v2/LogsSort/index.html index 7015c93827..a763dc819e 100644 --- a/v2/LogsSort/index.html +++ b/v2/LogsSort/index.html @@ -1 +1 @@ - LogsSort - Datadog API Client for Python
\ No newline at end of file + LogsSort - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsSortOrder/index.html b/v2/LogsSortOrder/index.html index afc9dc2a03..c1e9de4cd4 100644 --- a/v2/LogsSortOrder/index.html +++ b/v2/LogsSortOrder/index.html @@ -1 +1 @@ - LogsSortOrder - Datadog API Client for Python
\ No newline at end of file + LogsSortOrder - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/LogsWarning/index.html b/v2/LogsWarning/index.html index aad5087dc9..fc235752a2 100644 --- a/v2/LogsWarning/index.html +++ b/v2/LogsWarning/index.html @@ -1 +1 @@ - LogsWarning - Datadog API Client for Python

LogsWarning

A warning message indicating something that went wrong with the query

Properties

Name Type Description Notes
code str A unique code for this type of warning [optional]
detail str A detailed explanation of this specific warning [optional]
title str A short human-readable summary of the warning [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + LogsWarning - Datadog API Client for Python

LogsWarning

A warning message indicating something that went wrong with the query

Properties

Name Type Description Notes
code str A unique code for this type of warning [optional]
detail str A detailed explanation of this specific warning [optional]
title str A short human-readable summary of the warning [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/Metric/index.html b/v2/Metric/index.html index 92e9bc3a9f..7fe1da0eba 100644 --- a/v2/Metric/index.html +++ b/v2/Metric/index.html @@ -1 +1 @@ - Metric - Datadog API Client for Python
\ No newline at end of file + Metric - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricAllTags/index.html b/v2/MetricAllTags/index.html index 516167f858..1aa83ea432 100644 --- a/v2/MetricAllTags/index.html +++ b/v2/MetricAllTags/index.html @@ -1 +1 @@ - MetricAllTags - Datadog API Client for Python
\ No newline at end of file + MetricAllTags - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricAllTagsAttributes/index.html b/v2/MetricAllTagsAttributes/index.html index de6f67a13e..c3c432e15e 100644 --- a/v2/MetricAllTagsAttributes/index.html +++ b/v2/MetricAllTagsAttributes/index.html @@ -1 +1 @@ - MetricAllTagsAttributes - Datadog API Client for Python
\ No newline at end of file + MetricAllTagsAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricAllTagsResponse/index.html b/v2/MetricAllTagsResponse/index.html index c1edd92be1..97cccf7120 100644 --- a/v2/MetricAllTagsResponse/index.html +++ b/v2/MetricAllTagsResponse/index.html @@ -1 +1 @@ - MetricAllTagsResponse - Datadog API Client for Python
\ No newline at end of file + MetricAllTagsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricDistinctVolume/index.html b/v2/MetricDistinctVolume/index.html index 4e46ba8cc4..45cccdd1f4 100644 --- a/v2/MetricDistinctVolume/index.html +++ b/v2/MetricDistinctVolume/index.html @@ -1 +1 @@ - MetricDistinctVolume - Datadog API Client for Python
\ No newline at end of file + MetricDistinctVolume - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricDistinctVolumeAttributes/index.html b/v2/MetricDistinctVolumeAttributes/index.html index 1b632088ea..5ca37fd5ad 100644 --- a/v2/MetricDistinctVolumeAttributes/index.html +++ b/v2/MetricDistinctVolumeAttributes/index.html @@ -1 +1 @@ - MetricDistinctVolumeAttributes - Datadog API Client for Python

MetricDistinctVolumeAttributes

Object containing the definition of a metric's distinct volume.

Properties

Name Type Description Notes
distinct_volume int Distinct volume for the given metric. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + MetricDistinctVolumeAttributes - Datadog API Client for Python

MetricDistinctVolumeAttributes

Object containing the definition of a metric's distinct volume.

Properties

Name Type Description Notes
distinct_volume int Distinct volume for the given metric. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricDistinctVolumeType/index.html b/v2/MetricDistinctVolumeType/index.html index 2c69f95c4b..00c68fa55c 100644 --- a/v2/MetricDistinctVolumeType/index.html +++ b/v2/MetricDistinctVolumeType/index.html @@ -1 +1 @@ - MetricDistinctVolumeType - Datadog API Client for Python

MetricDistinctVolumeType

The metric distinct volume type.

Properties

Name Type Description Notes
value str The metric distinct volume type. defaults to "distinct_metric_volumes", must be one of ["distinct_metric_volumes", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + MetricDistinctVolumeType - Datadog API Client for Python

MetricDistinctVolumeType

The metric distinct volume type.

Properties

Name Type Description Notes
value str The metric distinct volume type. defaults to "distinct_metric_volumes", must be one of ["distinct_metric_volumes", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricIngestedIndexedVolume/index.html b/v2/MetricIngestedIndexedVolume/index.html index 4de2f37d05..e45540315a 100644 --- a/v2/MetricIngestedIndexedVolume/index.html +++ b/v2/MetricIngestedIndexedVolume/index.html @@ -1 +1 @@ - MetricIngestedIndexedVolume - Datadog API Client for Python
\ No newline at end of file + MetricIngestedIndexedVolume - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricIngestedIndexedVolumeAttributes/index.html b/v2/MetricIngestedIndexedVolumeAttributes/index.html index 3e4edbed47..329c62b0a0 100644 --- a/v2/MetricIngestedIndexedVolumeAttributes/index.html +++ b/v2/MetricIngestedIndexedVolumeAttributes/index.html @@ -1 +1 @@ - MetricIngestedIndexedVolumeAttributes - Datadog API Client for Python

MetricIngestedIndexedVolumeAttributes

Object containing the definition of a metric's ingested and indexed volume.

Properties

Name Type Description Notes
indexed_volume int Indexed volume for the given metric. [optional]
ingested_volume int Ingested volume for the given metric. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + MetricIngestedIndexedVolumeAttributes - Datadog API Client for Python

MetricIngestedIndexedVolumeAttributes

Object containing the definition of a metric's ingested and indexed volume.

Properties

Name Type Description Notes
indexed_volume int Indexed volume for the given metric. [optional]
ingested_volume int Ingested volume for the given metric. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricIngestedIndexedVolumeType/index.html b/v2/MetricIngestedIndexedVolumeType/index.html index 5bb5cba0a6..fae8ff3bce 100644 --- a/v2/MetricIngestedIndexedVolumeType/index.html +++ b/v2/MetricIngestedIndexedVolumeType/index.html @@ -1 +1 @@ - MetricIngestedIndexedVolumeType - Datadog API Client for Python

MetricIngestedIndexedVolumeType

The metric ingested and indexed volume type.

Properties

Name Type Description Notes
value str The metric ingested and indexed volume type. defaults to "metric_volumes", must be one of ["metric_volumes", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + MetricIngestedIndexedVolumeType - Datadog API Client for Python

MetricIngestedIndexedVolumeType

The metric ingested and indexed volume type.

Properties

Name Type Description Notes
value str The metric ingested and indexed volume type. defaults to "metric_volumes", must be one of ["metric_volumes", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfiguration/index.html b/v2/MetricTagConfiguration/index.html index ad623771fa..c1091b26b7 100644 --- a/v2/MetricTagConfiguration/index.html +++ b/v2/MetricTagConfiguration/index.html @@ -1 +1 @@ - MetricTagConfiguration - Datadog API Client for Python
\ No newline at end of file + MetricTagConfiguration - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricTagConfigurationAttributes/index.html b/v2/MetricTagConfigurationAttributes/index.html index 215bebf079..ba4bafb240 100644 --- a/v2/MetricTagConfigurationAttributes/index.html +++ b/v2/MetricTagConfigurationAttributes/index.html @@ -1 +1 @@ - MetricTagConfigurationAttributes - Datadog API Client for Python

MetricTagConfigurationAttributes

Object containing the definition of a metric tag configuration attributes.

Properties

Name Type Description Notes
created_at datetime Timestamp when the tag configuration was created. [optional]
include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional]
metric_type MetricTagConfigurationMetricTypes [optional]
modified_at datetime Timestamp when the tag configuration was last modified. [optional]
tags [str] List of tag keys on which to group. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricTagConfigurationAttributes - Datadog API Client for Python

MetricTagConfigurationAttributes

Object containing the definition of a metric tag configuration attributes.

Properties

Name Type Description Notes
created_at datetime Timestamp when the tag configuration was created. [optional]
include_percentiles bool Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. [optional]
metric_type MetricTagConfigurationMetricTypes [optional]
modified_at datetime Timestamp when the tag configuration was last modified. [optional]
tags [str] List of tag keys on which to group. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfigurationCreateAttributes/index.html b/v2/MetricTagConfigurationCreateAttributes/index.html index ae682ec5cc..a306517d18 100644 --- a/v2/MetricTagConfigurationCreateAttributes/index.html +++ b/v2/MetricTagConfigurationCreateAttributes/index.html @@ -1 +1 @@ - MetricTagConfigurationCreateAttributes - Datadog API Client for Python

MetricTagConfigurationCreateAttributes

Object containing the definition of a metric tag configuration to be created.

Properties

Name Type Description Notes
metric_type MetricTagConfigurationMetricTypes
tags [str] A list of tag keys that will be queryable for your metric. defaults to []
include_percentiles bool Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricTagConfigurationCreateAttributes - Datadog API Client for Python

MetricTagConfigurationCreateAttributes

Object containing the definition of a metric tag configuration to be created.

Properties

Name Type Description Notes
metric_type MetricTagConfigurationMetricTypes
tags [str] A list of tag keys that will be queryable for your metric. defaults to []
include_percentiles bool Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. [optional] if omitted the server will use the default value of False

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfigurationCreateData/index.html b/v2/MetricTagConfigurationCreateData/index.html index e66385963c..7c3d256c79 100644 --- a/v2/MetricTagConfigurationCreateData/index.html +++ b/v2/MetricTagConfigurationCreateData/index.html @@ -1 +1 @@ - MetricTagConfigurationCreateData - Datadog API Client for Python
\ No newline at end of file + MetricTagConfigurationCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricTagConfigurationCreateRequest/index.html b/v2/MetricTagConfigurationCreateRequest/index.html index f23b698169..76e7100894 100644 --- a/v2/MetricTagConfigurationCreateRequest/index.html +++ b/v2/MetricTagConfigurationCreateRequest/index.html @@ -1 +1 @@ - MetricTagConfigurationCreateRequest - Datadog API Client for Python
\ No newline at end of file + MetricTagConfigurationCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricTagConfigurationMetricTypes/index.html b/v2/MetricTagConfigurationMetricTypes/index.html index e0d4337ff4..9f39622091 100644 --- a/v2/MetricTagConfigurationMetricTypes/index.html +++ b/v2/MetricTagConfigurationMetricTypes/index.html @@ -1 +1 @@ - MetricTagConfigurationMetricTypes - Datadog API Client for Python

MetricTagConfigurationMetricTypes

The metric's type.

Properties

Name Type Description Notes
value str The metric's type. defaults to "gauge", must be one of ["gauge", "count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricTagConfigurationMetricTypes - Datadog API Client for Python

MetricTagConfigurationMetricTypes

The metric's type.

Properties

Name Type Description Notes
value str The metric's type. defaults to "gauge", must be one of ["gauge", "count", "distribution", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfigurationResponse/index.html b/v2/MetricTagConfigurationResponse/index.html index e26d2f0a75..834661480a 100644 --- a/v2/MetricTagConfigurationResponse/index.html +++ b/v2/MetricTagConfigurationResponse/index.html @@ -1 +1 @@ - MetricTagConfigurationResponse - Datadog API Client for Python
\ No newline at end of file + MetricTagConfigurationResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricTagConfigurationType/index.html b/v2/MetricTagConfigurationType/index.html index fe97addfca..b988da2804 100644 --- a/v2/MetricTagConfigurationType/index.html +++ b/v2/MetricTagConfigurationType/index.html @@ -1 +1 @@ - MetricTagConfigurationType - Datadog API Client for Python

MetricTagConfigurationType

The metric tag configuration resource type.

Properties

Name Type Description Notes
value str The metric tag configuration resource type. defaults to "manage_tags", must be one of ["manage_tags", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricTagConfigurationType - Datadog API Client for Python

MetricTagConfigurationType

The metric tag configuration resource type.

Properties

Name Type Description Notes
value str The metric tag configuration resource type. defaults to "manage_tags", must be one of ["manage_tags", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfigurationUpdateAttributes/index.html b/v2/MetricTagConfigurationUpdateAttributes/index.html index 807d765edf..1b717601a8 100644 --- a/v2/MetricTagConfigurationUpdateAttributes/index.html +++ b/v2/MetricTagConfigurationUpdateAttributes/index.html @@ -1 +1 @@ - MetricTagConfigurationUpdateAttributes - Datadog API Client for Python

MetricTagConfigurationUpdateAttributes

Object containing the definition of a metric tag configuration to be updated.

Properties

Name Type Description Notes
include_percentiles bool Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. [optional] if omitted the server will use the default value of False
tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of []

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricTagConfigurationUpdateAttributes - Datadog API Client for Python

MetricTagConfigurationUpdateAttributes

Object containing the definition of a metric tag configuration to be updated.

Properties

Name Type Description Notes
include_percentiles bool Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. [optional] if omitted the server will use the default value of False
tags [str] A list of tag keys that will be queryable for your metric. [optional] if omitted the server will use the default value of []

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricTagConfigurationUpdateData/index.html b/v2/MetricTagConfigurationUpdateData/index.html index a8fc38ff82..763f6ea56b 100644 --- a/v2/MetricTagConfigurationUpdateData/index.html +++ b/v2/MetricTagConfigurationUpdateData/index.html @@ -1 +1 @@ - MetricTagConfigurationUpdateData - Datadog API Client for Python
\ No newline at end of file + MetricTagConfigurationUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricTagConfigurationUpdateRequest/index.html b/v2/MetricTagConfigurationUpdateRequest/index.html index 1f813aa685..ddf63bca72 100644 --- a/v2/MetricTagConfigurationUpdateRequest/index.html +++ b/v2/MetricTagConfigurationUpdateRequest/index.html @@ -1 +1 @@ - MetricTagConfigurationUpdateRequest - Datadog API Client for Python
\ No newline at end of file + MetricTagConfigurationUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricType/index.html b/v2/MetricType/index.html index c9d1e5025a..fc92f87743 100644 --- a/v2/MetricType/index.html +++ b/v2/MetricType/index.html @@ -1 +1 @@ - MetricType - Datadog API Client for Python
\ No newline at end of file + MetricType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricVolumes/index.html b/v2/MetricVolumes/index.html index 67d207cf74..6f4538e120 100644 --- a/v2/MetricVolumes/index.html +++ b/v2/MetricVolumes/index.html @@ -1 +1 @@ - MetricVolumes - Datadog API Client for Python

MetricVolumes

Possible response objects for a metric's volume.

Properties

Name Type Description Notes
attributes MetricIngestedIndexedVolumeAttributes [optional]
id str The metric name for this resource. [optional]
type MetricIngestedIndexedVolumeType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 5, 2021
\ No newline at end of file + MetricVolumes - Datadog API Client for Python

MetricVolumes

Possible response objects for a metric's volume.

Properties

Name Type Description Notes
attributes MetricIngestedIndexedVolumeAttributes [optional]
id str The metric name for this resource. [optional]
type MetricIngestedIndexedVolumeType [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricVolumesResponse/index.html b/v2/MetricVolumesResponse/index.html index dedd88d89f..7ffb3d014a 100644 --- a/v2/MetricVolumesResponse/index.html +++ b/v2/MetricVolumesResponse/index.html @@ -1 +1 @@ - MetricVolumesResponse - Datadog API Client for Python
\ No newline at end of file + MetricVolumesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricsAndMetricTagConfigurations/index.html b/v2/MetricsAndMetricTagConfigurations/index.html index b457eacfa6..fcfcb73136 100644 --- a/v2/MetricsAndMetricTagConfigurations/index.html +++ b/v2/MetricsAndMetricTagConfigurations/index.html @@ -1 +1 @@ - MetricsAndMetricTagConfigurations - Datadog API Client for Python

MetricsAndMetricTagConfigurations

Object for a metrics and metric tag configurations.

Properties

Name Type Description Notes
id str The metric name for this resource. [optional]
type MetricTagConfigurationType [optional]
attributes MetricTagConfigurationAttributes [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 12, 2021
\ No newline at end of file + MetricsAndMetricTagConfigurations - Datadog API Client for Python

MetricsAndMetricTagConfigurations

Object for a metrics and metric tag configurations.

Properties

Name Type Description Notes
id str The metric name for this resource. [optional]
type MetricTagConfigurationType [optional]
attributes MetricTagConfigurationAttributes [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/MetricsAndMetricTagConfigurationsResponse/index.html b/v2/MetricsAndMetricTagConfigurationsResponse/index.html index 7279a72e63..39ee6c922d 100644 --- a/v2/MetricsAndMetricTagConfigurationsResponse/index.html +++ b/v2/MetricsAndMetricTagConfigurationsResponse/index.html @@ -1 +1 @@ - MetricsAndMetricTagConfigurationsResponse - Datadog API Client for Python
\ No newline at end of file + MetricsAndMetricTagConfigurationsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/MetricsApi/index.html b/v2/MetricsApi/index.html index 75dfac194f..6c853ae032 100644 --- a/v2/MetricsApi/index.html +++ b/v2/MetricsApi/index.html @@ -253,4 +253,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling MetricsApi->update_tag_configuration: %s\n" % e) -

Parameters

Name Type Description Notes
metric_name str The name of the metric.
body MetricTagConfigurationUpdateRequest

Return type

MetricTagConfigurationResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 22, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
metric_name str The name of the metric.
body MetricTagConfigurationUpdateRequest

Return type

MetricTagConfigurationResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
422 Unprocessable Entity -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/Organization/index.html b/v2/Organization/index.html index 04b77b3e1c..1bce8d3116 100644 --- a/v2/Organization/index.html +++ b/v2/Organization/index.html @@ -1 +1 @@ - Organization - Datadog API Client for Python
\ No newline at end of file + Organization - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/OrganizationAttributes/index.html b/v2/OrganizationAttributes/index.html index bd8fa6fa86..250bced519 100644 --- a/v2/OrganizationAttributes/index.html +++ b/v2/OrganizationAttributes/index.html @@ -1 +1 @@ - OrganizationAttributes - Datadog API Client for Python

OrganizationAttributes

Attributes of the organization.

Properties

Name Type Description Notes
created_at datetime Creation time of the organization. [optional]
description str Description of the organization. [optional]
disabled bool Whether or not the organization is disabled. [optional]
modified_at datetime Time of last organization modification. [optional]
name str Name of the organization. [optional]
public_id str Public ID of the organization. [optional]
sharing str Sharing type of the organization. [optional]
url str URL of the site that this organization exists at. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + OrganizationAttributes - Datadog API Client for Python

OrganizationAttributes

Attributes of the organization.

Properties

Name Type Description Notes
created_at datetime Creation time of the organization. [optional]
description str Description of the organization. [optional]
disabled bool Whether or not the organization is disabled. [optional]
modified_at datetime Time of last organization modification. [optional]
name str Name of the organization. [optional]
public_id str Public ID of the organization. [optional]
sharing str Sharing type of the organization. [optional]
url str URL of the site that this organization exists at. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/OrganizationsType/index.html b/v2/OrganizationsType/index.html index 1ee3a7696c..731798e704 100644 --- a/v2/OrganizationsType/index.html +++ b/v2/OrganizationsType/index.html @@ -1 +1 @@ - OrganizationsType - Datadog API Client for Python
\ No newline at end of file + OrganizationsType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/Pagination/index.html b/v2/Pagination/index.html index 6c3e956bdb..1521ea5d62 100644 --- a/v2/Pagination/index.html +++ b/v2/Pagination/index.html @@ -1 +1 @@ - Pagination - Datadog API Client for Python

Pagination

Pagination object.

Properties

Name Type Description Notes
total_count int Total count. [optional]
total_filtered_count int Total count of elements matched by the filter. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + Pagination - Datadog API Client for Python

Pagination

Pagination object.

Properties

Name Type Description Notes
total_count int Total count. [optional]
total_filtered_count int Total count of elements matched by the filter. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/PartialAPIKey/index.html b/v2/PartialAPIKey/index.html index 4c0ed14b33..624ca0270a 100644 --- a/v2/PartialAPIKey/index.html +++ b/v2/PartialAPIKey/index.html @@ -1 +1 @@ - PartialAPIKey - Datadog API Client for Python
\ No newline at end of file + PartialAPIKey - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/PartialAPIKeyAttributes/index.html b/v2/PartialAPIKeyAttributes/index.html index 99dc0ee8c0..47f34108ed 100644 --- a/v2/PartialAPIKeyAttributes/index.html +++ b/v2/PartialAPIKeyAttributes/index.html @@ -1 +1 @@ - PartialAPIKeyAttributes - Datadog API Client for Python

PartialAPIKeyAttributes

Attributes of a partial API key.

Properties

Name Type Description Notes
created_at str Creation date of the API key. [optional][readonly]
last4 str The last four characters of the API key. [optional][readonly]
modified_at str Date the API key was last modified. [optional][readonly]
name str Name of the API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 18, 2020
\ No newline at end of file + PartialAPIKeyAttributes - Datadog API Client for Python

PartialAPIKeyAttributes

Attributes of a partial API key.

Properties

Name Type Description Notes
created_at str Creation date of the API key. [optional][readonly]
last4 str The last four characters of the API key. [optional][readonly]
modified_at str Date the API key was last modified. [optional][readonly]
name str Name of the API key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/PartialApplicationKey/index.html b/v2/PartialApplicationKey/index.html index d588b028ae..0fa664b224 100644 --- a/v2/PartialApplicationKey/index.html +++ b/v2/PartialApplicationKey/index.html @@ -1 +1 @@ - PartialApplicationKey - Datadog API Client for Python
\ No newline at end of file + PartialApplicationKey - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/PartialApplicationKeyAttributes/index.html b/v2/PartialApplicationKeyAttributes/index.html index b7aa759b55..88b445d7bd 100644 --- a/v2/PartialApplicationKeyAttributes/index.html +++ b/v2/PartialApplicationKeyAttributes/index.html @@ -1 +1 @@ - PartialApplicationKeyAttributes - Datadog API Client for Python

PartialApplicationKeyAttributes

Attributes of a partial application key.

Properties

Name Type Description Notes
created_at str Creation date of the application key. [optional][readonly]
last4 str The last four characters of the application key. [optional][readonly]
name str Name of the application key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: January 5, 2021
\ No newline at end of file + PartialApplicationKeyAttributes - Datadog API Client for Python

PartialApplicationKeyAttributes

Attributes of a partial application key.

Properties

Name Type Description Notes
created_at str Creation date of the application key. [optional][readonly]
last4 str The last four characters of the application key. [optional][readonly]
name str Name of the application key. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/Permission/index.html b/v2/Permission/index.html index d9c7a5f5ca..8f55a8254d 100644 --- a/v2/Permission/index.html +++ b/v2/Permission/index.html @@ -1 +1 @@ - Permission - Datadog API Client for Python
\ No newline at end of file + Permission - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/PermissionAttributes/index.html b/v2/PermissionAttributes/index.html index bf5c2afea0..b8b0ee4faf 100644 --- a/v2/PermissionAttributes/index.html +++ b/v2/PermissionAttributes/index.html @@ -1 +1 @@ - PermissionAttributes - Datadog API Client for Python

PermissionAttributes

Attributes of a permission.

Properties

Name Type Description Notes
created datetime Creation time of the permission. [optional]
description str Description of the permission. [optional]
display_name str Displayed name for the permission. [optional]
display_type str Display type. [optional]
group_name str Name of the permission group. [optional]
name str Name of the permission. [optional]
restricted bool Whether or not the permission is restricted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + PermissionAttributes - Datadog API Client for Python

PermissionAttributes

Attributes of a permission.

Properties

Name Type Description Notes
created datetime Creation time of the permission. [optional]
description str Description of the permission. [optional]
display_name str Displayed name for the permission. [optional]
display_type str Display type. [optional]
group_name str Name of the permission group. [optional]
name str Name of the permission. [optional]
restricted bool Whether or not the permission is restricted. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/PermissionsResponse/index.html b/v2/PermissionsResponse/index.html index 9efba0121a..2763f697be 100644 --- a/v2/PermissionsResponse/index.html +++ b/v2/PermissionsResponse/index.html @@ -1 +1 @@ - PermissionsResponse - Datadog API Client for Python
\ No newline at end of file + PermissionsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/PermissionsType/index.html b/v2/PermissionsType/index.html index a078f08627..70757f5b25 100644 --- a/v2/PermissionsType/index.html +++ b/v2/PermissionsType/index.html @@ -1 +1 @@ - PermissionsType - Datadog API Client for Python
\ No newline at end of file + PermissionsType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ProcessSummariesMeta/index.html b/v2/ProcessSummariesMeta/index.html index cc48b6ec02..9319f26a6c 100644 --- a/v2/ProcessSummariesMeta/index.html +++ b/v2/ProcessSummariesMeta/index.html @@ -1 +1 @@ - ProcessSummariesMeta - Datadog API Client for Python
\ No newline at end of file + ProcessSummariesMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ProcessSummariesMetaPage/index.html b/v2/ProcessSummariesMetaPage/index.html index b77b8443c0..c4ecd7eb08 100644 --- a/v2/ProcessSummariesMetaPage/index.html +++ b/v2/ProcessSummariesMetaPage/index.html @@ -1 +1 @@ - ProcessSummariesMetaPage - Datadog API Client for Python

ProcessSummariesMetaPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. [optional]
size int Number of results returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 24, 2020
\ No newline at end of file + ProcessSummariesMetaPage - Datadog API Client for Python

ProcessSummariesMetaPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. [optional]
size int Number of results returned. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/ProcessSummariesResponse/index.html b/v2/ProcessSummariesResponse/index.html index 1afa5a4e83..8148ae530d 100644 --- a/v2/ProcessSummariesResponse/index.html +++ b/v2/ProcessSummariesResponse/index.html @@ -1 +1 @@ - ProcessSummariesResponse - Datadog API Client for Python
\ No newline at end of file + ProcessSummariesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ProcessSummary/index.html b/v2/ProcessSummary/index.html index 3691fcce88..7c62aba260 100644 --- a/v2/ProcessSummary/index.html +++ b/v2/ProcessSummary/index.html @@ -1 +1 @@ - ProcessSummary - Datadog API Client for Python
\ No newline at end of file + ProcessSummary - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ProcessSummaryAttributes/index.html b/v2/ProcessSummaryAttributes/index.html index 39042bf09f..f605ac0ffa 100644 --- a/v2/ProcessSummaryAttributes/index.html +++ b/v2/ProcessSummaryAttributes/index.html @@ -1 +1 @@ - ProcessSummaryAttributes - Datadog API Client for Python

ProcessSummaryAttributes

Attributes for a process summary.

Properties

Name Type Description Notes
cmdline str Process command line. [optional]
host str Host running the process. [optional]
pid int Process ID. [optional]
ppid int Parent process ID. [optional]
start str Time the process was started. [optional]
tags [str] List of tags associated with the process. [optional]
timestamp str Time the process was seen. [optional]
user str Process owner. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: November 24, 2020
\ No newline at end of file + ProcessSummaryAttributes - Datadog API Client for Python

ProcessSummaryAttributes

Attributes for a process summary.

Properties

Name Type Description Notes
cmdline str Process command line. [optional]
host str Host running the process. [optional]
pid int Process ID. [optional]
ppid int Parent process ID. [optional]
start str Time the process was started. [optional]
tags [str] List of tags associated with the process. [optional]
timestamp str Time the process was seen. [optional]
user str Process owner. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/ProcessSummaryType/index.html b/v2/ProcessSummaryType/index.html index 45f745f265..145e1e161c 100644 --- a/v2/ProcessSummaryType/index.html +++ b/v2/ProcessSummaryType/index.html @@ -1 +1 @@ - ProcessSummaryType - Datadog API Client for Python
\ No newline at end of file + ProcessSummaryType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ProcessesApi/index.html b/v2/ProcessesApi/index.html index 6520c97874..f5b0302121 100644 --- a/v2/ProcessesApi/index.html +++ b/v2/ProcessesApi/index.html @@ -36,4 +36,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling ProcessesApi->list_processes: %s\n" % e) -

Parameters

Name Type Description Notes
search str String to search processes by. [optional]
tags str Comma-separated list of tags to filter processes by. [optional]
_from int Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. [optional]
to int Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. [optional]
page_limit int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000
page_cursor str String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. [optional]

Return type

ProcessSummariesResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
search str String to search processes by. [optional]
tags str Comma-separated list of tags to filter processes by. [optional]
_from int Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. [optional]
to int Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. [optional]
page_limit int Maximum number of results returned. [optional] if omitted the server will use the default value of 1000
page_cursor str String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. [optional]

Return type

ProcessSummariesResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/QuerySortOrder/index.html b/v2/QuerySortOrder/index.html index 2221550f9a..d81bc5d854 100644 --- a/v2/QuerySortOrder/index.html +++ b/v2/QuerySortOrder/index.html @@ -1 +1 @@ - QuerySortOrder - Datadog API Client for Python
\ No newline at end of file + QuerySortOrder - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToIncidentIntegrationMetadataData/index.html b/v2/RelationshipToIncidentIntegrationMetadataData/index.html index b3e5cb6934..afdab7d1f6 100644 --- a/v2/RelationshipToIncidentIntegrationMetadataData/index.html +++ b/v2/RelationshipToIncidentIntegrationMetadataData/index.html @@ -1 +1 @@ - RelationshipToIncidentIntegrationMetadataData - Datadog API Client for Python
\ No newline at end of file + RelationshipToIncidentIntegrationMetadataData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToIncidentIntegrationMetadatas/index.html b/v2/RelationshipToIncidentIntegrationMetadatas/index.html index 932a93d7cb..fe5e02d858 100644 --- a/v2/RelationshipToIncidentIntegrationMetadatas/index.html +++ b/v2/RelationshipToIncidentIntegrationMetadatas/index.html @@ -1 +1 @@ - RelationshipToIncidentIntegrationMetadatas - Datadog API Client for Python
\ No newline at end of file + RelationshipToIncidentIntegrationMetadatas - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToIncidentPostmortem/index.html b/v2/RelationshipToIncidentPostmortem/index.html index d82696e169..4fc1e75be9 100644 --- a/v2/RelationshipToIncidentPostmortem/index.html +++ b/v2/RelationshipToIncidentPostmortem/index.html @@ -1 +1 @@ - RelationshipToIncidentPostmortem - Datadog API Client for Python
\ No newline at end of file + RelationshipToIncidentPostmortem - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToIncidentPostmortemData/index.html b/v2/RelationshipToIncidentPostmortemData/index.html index 222228a512..fc7ef90bc7 100644 --- a/v2/RelationshipToIncidentPostmortemData/index.html +++ b/v2/RelationshipToIncidentPostmortemData/index.html @@ -1 +1 @@ - RelationshipToIncidentPostmortemData - Datadog API Client for Python
\ No newline at end of file + RelationshipToIncidentPostmortemData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToOrganization/index.html b/v2/RelationshipToOrganization/index.html index 516e2df15c..f17c51b8b7 100644 --- a/v2/RelationshipToOrganization/index.html +++ b/v2/RelationshipToOrganization/index.html @@ -1 +1 @@ - RelationshipToOrganization - Datadog API Client for Python
\ No newline at end of file + RelationshipToOrganization - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToOrganizationData/index.html b/v2/RelationshipToOrganizationData/index.html index a68bc572ab..4dd672d57a 100644 --- a/v2/RelationshipToOrganizationData/index.html +++ b/v2/RelationshipToOrganizationData/index.html @@ -1 +1 @@ - RelationshipToOrganizationData - Datadog API Client for Python
\ No newline at end of file + RelationshipToOrganizationData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToOrganizations/index.html b/v2/RelationshipToOrganizations/index.html index b05da8682f..054b59220d 100644 --- a/v2/RelationshipToOrganizations/index.html +++ b/v2/RelationshipToOrganizations/index.html @@ -1 +1 @@ - RelationshipToOrganizations - Datadog API Client for Python
\ No newline at end of file + RelationshipToOrganizations - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToPermission/index.html b/v2/RelationshipToPermission/index.html index 030769069d..4f6b6c9552 100644 --- a/v2/RelationshipToPermission/index.html +++ b/v2/RelationshipToPermission/index.html @@ -1 +1 @@ - RelationshipToPermission - Datadog API Client for Python
\ No newline at end of file + RelationshipToPermission - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToPermissionData/index.html b/v2/RelationshipToPermissionData/index.html index ed79ee4024..f894f1212a 100644 --- a/v2/RelationshipToPermissionData/index.html +++ b/v2/RelationshipToPermissionData/index.html @@ -1 +1 @@ - RelationshipToPermissionData - Datadog API Client for Python
\ No newline at end of file + RelationshipToPermissionData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToPermissions/index.html b/v2/RelationshipToPermissions/index.html index 691abef554..0a7b337b90 100644 --- a/v2/RelationshipToPermissions/index.html +++ b/v2/RelationshipToPermissions/index.html @@ -1 +1 @@ - RelationshipToPermissions - Datadog API Client for Python
\ No newline at end of file + RelationshipToPermissions - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToRole/index.html b/v2/RelationshipToRole/index.html index 81307f2d88..01ba93f8c8 100644 --- a/v2/RelationshipToRole/index.html +++ b/v2/RelationshipToRole/index.html @@ -1 +1 @@ - RelationshipToRole - Datadog API Client for Python
\ No newline at end of file + RelationshipToRole - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToRoleData/index.html b/v2/RelationshipToRoleData/index.html index fec30920cb..c2fad6e2a0 100644 --- a/v2/RelationshipToRoleData/index.html +++ b/v2/RelationshipToRoleData/index.html @@ -1 +1 @@ - RelationshipToRoleData - Datadog API Client for Python
\ No newline at end of file + RelationshipToRoleData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToRoles/index.html b/v2/RelationshipToRoles/index.html index 6b4b4fc245..f37763a989 100644 --- a/v2/RelationshipToRoles/index.html +++ b/v2/RelationshipToRoles/index.html @@ -1 +1 @@ - RelationshipToRoles - Datadog API Client for Python
\ No newline at end of file + RelationshipToRoles - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToUser/index.html b/v2/RelationshipToUser/index.html index 80683338f9..f1ced76334 100644 --- a/v2/RelationshipToUser/index.html +++ b/v2/RelationshipToUser/index.html @@ -1 +1 @@ - RelationshipToUser - Datadog API Client for Python
\ No newline at end of file + RelationshipToUser - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToUserData/index.html b/v2/RelationshipToUserData/index.html index c261429fc1..b26eb71ce5 100644 --- a/v2/RelationshipToUserData/index.html +++ b/v2/RelationshipToUserData/index.html @@ -1 +1 @@ - RelationshipToUserData - Datadog API Client for Python
\ No newline at end of file + RelationshipToUserData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RelationshipToUsers/index.html b/v2/RelationshipToUsers/index.html index 054ca355e9..3bd135961b 100644 --- a/v2/RelationshipToUsers/index.html +++ b/v2/RelationshipToUsers/index.html @@ -1 +1 @@ - RelationshipToUsers - Datadog API Client for Python
\ No newline at end of file + RelationshipToUsers - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/ResponseMetaAttributes/index.html b/v2/ResponseMetaAttributes/index.html index 4361a44d25..f5ce4aef2d 100644 --- a/v2/ResponseMetaAttributes/index.html +++ b/v2/ResponseMetaAttributes/index.html @@ -1 +1 @@ - ResponseMetaAttributes - Datadog API Client for Python
\ No newline at end of file + ResponseMetaAttributes - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/Role/index.html b/v2/Role/index.html index 6bb13d8cf7..fc5c92d0c4 100644 --- a/v2/Role/index.html +++ b/v2/Role/index.html @@ -1 +1 @@ - Role - Datadog API Client for Python
\ No newline at end of file + Role - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleAttributes/index.html b/v2/RoleAttributes/index.html index ede6299515..b7884192ab 100644 --- a/v2/RoleAttributes/index.html +++ b/v2/RoleAttributes/index.html @@ -1 +1 @@ - RoleAttributes - Datadog API Client for Python

RoleAttributes

Attributes of the role.

Properties

Name Type Description Notes
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]
name str Name of the role. [optional]
user_count int Number of users with that role. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + RoleAttributes - Datadog API Client for Python

RoleAttributes

Attributes of the role.

Properties

Name Type Description Notes
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]
name str Name of the role. [optional]
user_count int Number of users with that role. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/RoleCreateAttributes/index.html b/v2/RoleCreateAttributes/index.html index 766ac558a9..19d3047a23 100644 --- a/v2/RoleCreateAttributes/index.html +++ b/v2/RoleCreateAttributes/index.html @@ -1 +1 @@ - RoleCreateAttributes - Datadog API Client for Python

RoleCreateAttributes

Attributes of the created role.

Properties

Name Type Description Notes
name str Name of the role.
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 23, 2020
\ No newline at end of file + RoleCreateAttributes - Datadog API Client for Python

RoleCreateAttributes

Attributes of the created role.

Properties

Name Type Description Notes
name str Name of the role.
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/RoleCreateData/index.html b/v2/RoleCreateData/index.html index c2ebe9ed62..c871907d5f 100644 --- a/v2/RoleCreateData/index.html +++ b/v2/RoleCreateData/index.html @@ -1 +1 @@ - RoleCreateData - Datadog API Client for Python
\ No newline at end of file + RoleCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleCreateRequest/index.html b/v2/RoleCreateRequest/index.html index 4fe161a185..cef8bd69fb 100644 --- a/v2/RoleCreateRequest/index.html +++ b/v2/RoleCreateRequest/index.html @@ -1 +1 @@ - RoleCreateRequest - Datadog API Client for Python
\ No newline at end of file + RoleCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleCreateResponse/index.html b/v2/RoleCreateResponse/index.html index 9631e7b0a9..611c62c4a6 100644 --- a/v2/RoleCreateResponse/index.html +++ b/v2/RoleCreateResponse/index.html @@ -1 +1 @@ - RoleCreateResponse - Datadog API Client for Python
\ No newline at end of file + RoleCreateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleCreateResponseData/index.html b/v2/RoleCreateResponseData/index.html index ae52684d95..104b10e65d 100644 --- a/v2/RoleCreateResponseData/index.html +++ b/v2/RoleCreateResponseData/index.html @@ -1 +1 @@ - RoleCreateResponseData - Datadog API Client for Python
\ No newline at end of file + RoleCreateResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleRelationships/index.html b/v2/RoleRelationships/index.html index 390da1389b..fcedddfb23 100644 --- a/v2/RoleRelationships/index.html +++ b/v2/RoleRelationships/index.html @@ -1 +1 @@ - RoleRelationships - Datadog API Client for Python
\ No newline at end of file + RoleRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleResponse/index.html b/v2/RoleResponse/index.html index b7d0f4f0a4..2118ee7439 100644 --- a/v2/RoleResponse/index.html +++ b/v2/RoleResponse/index.html @@ -1 +1 @@ - RoleResponse - Datadog API Client for Python
\ No newline at end of file + RoleResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleResponseRelationships/index.html b/v2/RoleResponseRelationships/index.html index ba9a983b7a..23e29dfcca 100644 --- a/v2/RoleResponseRelationships/index.html +++ b/v2/RoleResponseRelationships/index.html @@ -1 +1 @@ - RoleResponseRelationships - Datadog API Client for Python
\ No newline at end of file + RoleResponseRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleUpdateAttributes/index.html b/v2/RoleUpdateAttributes/index.html index b63403a40d..26194f34c5 100644 --- a/v2/RoleUpdateAttributes/index.html +++ b/v2/RoleUpdateAttributes/index.html @@ -1 +1 @@ - RoleUpdateAttributes - Datadog API Client for Python

RoleUpdateAttributes

Attributes of the role.

Properties

Name Type Description Notes
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]
name str Name of the role. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + RoleUpdateAttributes - Datadog API Client for Python

RoleUpdateAttributes

Attributes of the role.

Properties

Name Type Description Notes
created_at datetime Creation time of the role. [optional][readonly]
modified_at datetime Time of last role modification. [optional][readonly]
name str Name of the role. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/RoleUpdateData/index.html b/v2/RoleUpdateData/index.html index dd24a957b0..ad25f07b3a 100644 --- a/v2/RoleUpdateData/index.html +++ b/v2/RoleUpdateData/index.html @@ -1 +1 @@ - RoleUpdateData - Datadog API Client for Python
\ No newline at end of file + RoleUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleUpdateRequest/index.html b/v2/RoleUpdateRequest/index.html index 0e62a84a2e..710ea4e6e2 100644 --- a/v2/RoleUpdateRequest/index.html +++ b/v2/RoleUpdateRequest/index.html @@ -1 +1 @@ - RoleUpdateRequest - Datadog API Client for Python
\ No newline at end of file + RoleUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleUpdateResponse/index.html b/v2/RoleUpdateResponse/index.html index 6a9017c48d..0814c91535 100644 --- a/v2/RoleUpdateResponse/index.html +++ b/v2/RoleUpdateResponse/index.html @@ -1 +1 @@ - RoleUpdateResponse - Datadog API Client for Python
\ No newline at end of file + RoleUpdateResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RoleUpdateResponseData/index.html b/v2/RoleUpdateResponseData/index.html index 661eed6b22..054c79a686 100644 --- a/v2/RoleUpdateResponseData/index.html +++ b/v2/RoleUpdateResponseData/index.html @@ -1 +1 @@ - RoleUpdateResponseData - Datadog API Client for Python
\ No newline at end of file + RoleUpdateResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RolesApi/index.html b/v2/RolesApi/index.html index 2b77562b27..c788cff559 100644 --- a/v2/RolesApi/index.html +++ b/v2/RolesApi/index.html @@ -454,4 +454,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->update_role: %s\n" % e) -

Parameters

Name Type Description Notes
role_id str The ID of the role.
body RoleUpdateRequest

Return type

RoleUpdateResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Not found -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
role_id str The ID of the role.
body RoleUpdateRequest

Return type

RoleUpdateResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Not found -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/RolesResponse/index.html b/v2/RolesResponse/index.html index c1f6777363..9f48654ffe 100644 --- a/v2/RolesResponse/index.html +++ b/v2/RolesResponse/index.html @@ -1 +1 @@ - RolesResponse - Datadog API Client for Python
\ No newline at end of file + RolesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/RolesSort/index.html b/v2/RolesSort/index.html index bb92c4a77d..8653e40b04 100644 --- a/v2/RolesSort/index.html +++ b/v2/RolesSort/index.html @@ -1 +1 @@ - RolesSort - Datadog API Client for Python

RolesSort

Sorting options for roles.

Properties

Name Type Description Notes
value str Sorting options for roles. defaults to "name", must be one of ["name", "-name", "modified_at", "-modified_at", "user_count", "-user_count", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 16, 2020
\ No newline at end of file + RolesSort - Datadog API Client for Python

RolesSort

Sorting options for roles.

Properties

Name Type Description Notes
value str Sorting options for roles. defaults to "name", must be one of ["name", "-name", "modified_at", "-modified_at", "user_count", "-user_count", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/RolesType/index.html b/v2/RolesType/index.html index 8eb59c26a0..f00b72ed0e 100644 --- a/v2/RolesType/index.html +++ b/v2/RolesType/index.html @@ -1 +1 @@ - RolesType - Datadog API Client for Python
\ No newline at end of file + RolesType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringApi/index.html b/v2/SecurityMonitoringApi/index.html index 4ad9a7c95f..2cae4ec5c5 100644 --- a/v2/SecurityMonitoringApi/index.html +++ b/v2/SecurityMonitoringApi/index.html @@ -314,4 +314,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\n" % e) -

Parameters

Name Type Description Notes
rule_id str The ID of the rule.
body SecurityMonitoringRuleUpdatePayload

Return type

SecurityMonitoringRuleResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Concurrent Modification -
403 Not Authorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
rule_id str The ID of the rule.
body SecurityMonitoringRuleUpdatePayload

Return type

SecurityMonitoringRuleResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Concurrent Modification -
403 Not Authorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringFilter/index.html b/v2/SecurityMonitoringFilter/index.html index 66cefacc97..680ed934c3 100644 --- a/v2/SecurityMonitoringFilter/index.html +++ b/v2/SecurityMonitoringFilter/index.html @@ -1 +1 @@ - SecurityMonitoringFilter - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringFilter - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringFilterAction/index.html b/v2/SecurityMonitoringFilterAction/index.html index d89e9bec2a..4546aac96c 100644 --- a/v2/SecurityMonitoringFilterAction/index.html +++ b/v2/SecurityMonitoringFilterAction/index.html @@ -1 +1 @@ - SecurityMonitoringFilterAction - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringFilterAction - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringListRulesResponse/index.html b/v2/SecurityMonitoringListRulesResponse/index.html index 6e61e3b97e..dcfbe4dcdc 100644 --- a/v2/SecurityMonitoringListRulesResponse/index.html +++ b/v2/SecurityMonitoringListRulesResponse/index.html @@ -1 +1 @@ - SecurityMonitoringListRulesResponse - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringListRulesResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleCase/index.html b/v2/SecurityMonitoringRuleCase/index.html index 81881b5f54..08e78f5765 100644 --- a/v2/SecurityMonitoringRuleCase/index.html +++ b/v2/SecurityMonitoringRuleCase/index.html @@ -1 +1 @@ - SecurityMonitoringRuleCase - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringRuleCase - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleCaseCreate/index.html b/v2/SecurityMonitoringRuleCaseCreate/index.html index 8c811e4d91..582bf640f0 100644 --- a/v2/SecurityMonitoringRuleCaseCreate/index.html +++ b/v2/SecurityMonitoringRuleCaseCreate/index.html @@ -1 +1 @@ - SecurityMonitoringRuleCaseCreate - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringRuleCaseCreate - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleCreatePayload/index.html b/v2/SecurityMonitoringRuleCreatePayload/index.html index ccad9a91ba..327008bd8a 100644 --- a/v2/SecurityMonitoringRuleCreatePayload/index.html +++ b/v2/SecurityMonitoringRuleCreatePayload/index.html @@ -1 +1 @@ - SecurityMonitoringRuleCreatePayload - Datadog API Client for Python

SecurityMonitoringRuleCreatePayload

Create a new rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals.
is_enabled bool Whether the rule is enabled.
message str Message for generated signals.
name str The name of the rule.
options SecurityMonitoringRuleOptions
queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule.
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
tags [str] Tags for generated signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 29, 2020
\ No newline at end of file + SecurityMonitoringRuleCreatePayload - Datadog API Client for Python

SecurityMonitoringRuleCreatePayload

Create a new rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCaseCreate] Cases for generating signals.
is_enabled bool Whether the rule is enabled.
message str Message for generated signals.
name str The name of the rule.
options SecurityMonitoringRuleOptions
queries [SecurityMonitoringRuleQueryCreate] Queries for selecting logs which are part of the rule.
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
tags [str] Tags for generated signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleDetectionMethod/index.html b/v2/SecurityMonitoringRuleDetectionMethod/index.html index 2aeaa779a3..3ee7cad4c1 100644 --- a/v2/SecurityMonitoringRuleDetectionMethod/index.html +++ b/v2/SecurityMonitoringRuleDetectionMethod/index.html @@ -1 +1 @@ - SecurityMonitoringRuleDetectionMethod - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringRuleDetectionMethod - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleEvaluationWindow/index.html b/v2/SecurityMonitoringRuleEvaluationWindow/index.html index 4527da2946..f1ca63ebea 100644 --- a/v2/SecurityMonitoringRuleEvaluationWindow/index.html +++ b/v2/SecurityMonitoringRuleEvaluationWindow/index.html @@ -1 +1 @@ - SecurityMonitoringRuleEvaluationWindow - Datadog API Client for Python

SecurityMonitoringRuleEvaluationWindow

A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time.

Properties

Name Type Description Notes
value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringRuleEvaluationWindow - Datadog API Client for Python

SecurityMonitoringRuleEvaluationWindow

A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time.

Properties

Name Type Description Notes
value int A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleKeepAlive/index.html b/v2/SecurityMonitoringRuleKeepAlive/index.html index ff05b5808f..e3b6b9070a 100644 --- a/v2/SecurityMonitoringRuleKeepAlive/index.html +++ b/v2/SecurityMonitoringRuleKeepAlive/index.html @@ -1 +1 @@ - SecurityMonitoringRuleKeepAlive - Datadog API Client for Python

SecurityMonitoringRuleKeepAlive

Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window.

Properties

Name Type Description Notes
value int Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 10, 2020
\ No newline at end of file + SecurityMonitoringRuleKeepAlive - Datadog API Client for Python

SecurityMonitoringRuleKeepAlive

Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window.

Properties

Name Type Description Notes
value int Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleMaxSignalDuration/index.html b/v2/SecurityMonitoringRuleMaxSignalDuration/index.html index 00e75cf917..9840a8be18 100644 --- a/v2/SecurityMonitoringRuleMaxSignalDuration/index.html +++ b/v2/SecurityMonitoringRuleMaxSignalDuration/index.html @@ -1 +1 @@ - SecurityMonitoringRuleMaxSignalDuration - Datadog API Client for Python

SecurityMonitoringRuleMaxSignalDuration

A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.

Properties

Name Type Description Notes
value int A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringRuleMaxSignalDuration - Datadog API Client for Python

SecurityMonitoringRuleMaxSignalDuration

A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.

Properties

Name Type Description Notes
value int A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleNewValueOptions/index.html b/v2/SecurityMonitoringRuleNewValueOptions/index.html index af408f726a..0b9cd96f75 100644 --- a/v2/SecurityMonitoringRuleNewValueOptions/index.html +++ b/v2/SecurityMonitoringRuleNewValueOptions/index.html @@ -1 +1 @@ - SecurityMonitoringRuleNewValueOptions - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringRuleNewValueOptions - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/index.html b/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/index.html index 1b066fb5c3..cba0bb739e 100644 --- a/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/index.html +++ b/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter/index.html @@ -1 +1 @@ - SecurityMonitoringRuleNewValueOptionsForgetAfter - Datadog API Client for Python

SecurityMonitoringRuleNewValueOptionsForgetAfter

The duration in days after which a learned value is forgotten.

Properties

Name Type Description Notes
value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 22, 2021
\ No newline at end of file + SecurityMonitoringRuleNewValueOptionsForgetAfter - Datadog API Client for Python

SecurityMonitoringRuleNewValueOptionsForgetAfter

The duration in days after which a learned value is forgotten.

Properties

Name Type Description Notes
value int The duration in days after which a learned value is forgotten. must be one of [1, 2, 7, 14, 21, 28, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/index.html b/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/index.html index 46061649be..81c29735d3 100644 --- a/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/index.html +++ b/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration/index.html @@ -1 +1 @@ - SecurityMonitoringRuleNewValueOptionsLearningDuration - Datadog API Client for Python

SecurityMonitoringRuleNewValueOptionsLearningDuration

The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.

Properties

Name Type Description Notes
value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 22, 2021
\ No newline at end of file + SecurityMonitoringRuleNewValueOptionsLearningDuration - Datadog API Client for Python

SecurityMonitoringRuleNewValueOptionsLearningDuration

The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.

Properties

Name Type Description Notes
value int The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. must be one of [0, 1, 7, ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleOptions/index.html b/v2/SecurityMonitoringRuleOptions/index.html index fb91880241..56bd086254 100644 --- a/v2/SecurityMonitoringRuleOptions/index.html +++ b/v2/SecurityMonitoringRuleOptions/index.html @@ -1 +1 @@ - SecurityMonitoringRuleOptions - Datadog API Client for Python

SecurityMonitoringRuleOptions

Options on rules.

Properties

Name Type Description Notes
detection_method SecurityMonitoringRuleDetectionMethod [optional]
evaluation_window SecurityMonitoringRuleEvaluationWindow [optional]
keep_alive SecurityMonitoringRuleKeepAlive [optional]
max_signal_duration SecurityMonitoringRuleMaxSignalDuration [optional]
new_value_options SecurityMonitoringRuleNewValueOptions [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 22, 2021
\ No newline at end of file + SecurityMonitoringRuleOptions - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleQuery/index.html b/v2/SecurityMonitoringRuleQuery/index.html index acf90e372f..19a8cb7e90 100644 --- a/v2/SecurityMonitoringRuleQuery/index.html +++ b/v2/SecurityMonitoringRuleQuery/index.html @@ -1 +1 @@ - SecurityMonitoringRuleQuery - Datadog API Client for Python

SecurityMonitoringRuleQuery

Query for matching rule.

Properties

Name Type Description Notes
aggregation SecurityMonitoringRuleQueryAggregation [optional]
distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional]
group_by_fields [str] Fields to group by. [optional]
metric str The target field to aggregate over when using the sum or max aggregations. [optional]
name str Name of the query. [optional]
query str Query to run on logs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 15, 2020
\ No newline at end of file + SecurityMonitoringRuleQuery - Datadog API Client for Python

SecurityMonitoringRuleQuery

Query for matching rule.

Properties

Name Type Description Notes
aggregation SecurityMonitoringRuleQueryAggregation [optional]
distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional]
group_by_fields [str] Fields to group by. [optional]
metric str The target field to aggregate over when using the sum or max aggregations. [optional]
name str Name of the query. [optional]
query str Query to run on logs. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleQueryAggregation/index.html b/v2/SecurityMonitoringRuleQueryAggregation/index.html index 66be679863..dafc7839ca 100644 --- a/v2/SecurityMonitoringRuleQueryAggregation/index.html +++ b/v2/SecurityMonitoringRuleQueryAggregation/index.html @@ -1 +1 @@ - SecurityMonitoringRuleQueryAggregation - Datadog API Client for Python

SecurityMonitoringRuleQueryAggregation

The aggregation type.

Properties

Name Type Description Notes
value str The aggregation type. must be one of ["count", "cardinality", "sum", "max", "new_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: February 22, 2021
\ No newline at end of file + SecurityMonitoringRuleQueryAggregation - Datadog API Client for Python

SecurityMonitoringRuleQueryAggregation

The aggregation type.

Properties

Name Type Description Notes
value str The aggregation type. must be one of ["count", "cardinality", "sum", "max", "new_value", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleQueryCreate/index.html b/v2/SecurityMonitoringRuleQueryCreate/index.html index d9c30335fe..900638d8d2 100644 --- a/v2/SecurityMonitoringRuleQueryCreate/index.html +++ b/v2/SecurityMonitoringRuleQueryCreate/index.html @@ -1 +1 @@ - SecurityMonitoringRuleQueryCreate - Datadog API Client for Python

SecurityMonitoringRuleQueryCreate

Query for matching rule.

Properties

Name Type Description Notes
query str Query to run on logs.
aggregation SecurityMonitoringRuleQueryAggregation [optional]
distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional]
group_by_fields [str] Fields to group by. [optional]
metric str The target field to aggregate over when using the sum or max aggregations. [optional]
name str Name of the query. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 15, 2020
\ No newline at end of file + SecurityMonitoringRuleQueryCreate - Datadog API Client for Python

SecurityMonitoringRuleQueryCreate

Query for matching rule.

Properties

Name Type Description Notes
query str Query to run on logs.
aggregation SecurityMonitoringRuleQueryAggregation [optional]
distinct_fields [str] Field for which the cardinality is measured. Sent as an array. [optional]
group_by_fields [str] Fields to group by. [optional]
metric str The target field to aggregate over when using the sum or max aggregations. [optional]
name str Name of the query. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleResponse/index.html b/v2/SecurityMonitoringRuleResponse/index.html index 1de1e6c67f..71ec6cd697 100644 --- a/v2/SecurityMonitoringRuleResponse/index.html +++ b/v2/SecurityMonitoringRuleResponse/index.html @@ -1 +1 @@ - SecurityMonitoringRuleResponse - Datadog API Client for Python

SecurityMonitoringRuleResponse

Detection rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional]
created_at int When the rule was created, timestamp in milliseconds. [optional]
creation_author_id int User ID of the user who created the rule. [optional]
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
id str The ID of the rule. [optional]
is_default bool Whether the rule is included by default. [optional]
is_deleted bool Whether the rule has been deleted. [optional]
is_enabled bool Whether the rule is enabled. [optional]
message str Message for generated signals. [optional]
name str The name of the rule. [optional]
options SecurityMonitoringRuleOptions [optional]
queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional]
tags [str] Tags for generated signals. [optional]
version int The version of the rule. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 29, 2020
\ No newline at end of file + SecurityMonitoringRuleResponse - Datadog API Client for Python

SecurityMonitoringRuleResponse

Detection rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional]
created_at int When the rule was created, timestamp in milliseconds. [optional]
creation_author_id int User ID of the user who created the rule. [optional]
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
id str The ID of the rule. [optional]
is_default bool Whether the rule is included by default. [optional]
is_deleted bool Whether the rule has been deleted. [optional]
is_enabled bool Whether the rule is enabled. [optional]
message str Message for generated signals. [optional]
name str The name of the rule. [optional]
options SecurityMonitoringRuleOptions [optional]
queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional]
tags [str] Tags for generated signals. [optional]
version int The version of the rule. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleSeverity/index.html b/v2/SecurityMonitoringRuleSeverity/index.html index 1544a9f693..c903f80887 100644 --- a/v2/SecurityMonitoringRuleSeverity/index.html +++ b/v2/SecurityMonitoringRuleSeverity/index.html @@ -1 +1 @@ - SecurityMonitoringRuleSeverity - Datadog API Client for Python

SecurityMonitoringRuleSeverity

Severity of the Security Signal.

Properties

Name Type Description Notes
value str Severity of the Security Signal. must be one of ["info", "low", "medium", "high", "critical", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringRuleSeverity - Datadog API Client for Python

SecurityMonitoringRuleSeverity

Severity of the Security Signal.

Properties

Name Type Description Notes
value str Severity of the Security Signal. must be one of ["info", "low", "medium", "high", "critical", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringRuleUpdatePayload/index.html b/v2/SecurityMonitoringRuleUpdatePayload/index.html index 03f22c0a94..c24d2e9e49 100644 --- a/v2/SecurityMonitoringRuleUpdatePayload/index.html +++ b/v2/SecurityMonitoringRuleUpdatePayload/index.html @@ -1 +1 @@ - SecurityMonitoringRuleUpdatePayload - Datadog API Client for Python

SecurityMonitoringRuleUpdatePayload

Update an existing rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional]
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
is_enabled bool Whether the rule is enabled. [optional]
message str Message for generated signals. [optional]
name str Name of the rule. [optional]
options SecurityMonitoringRuleOptions [optional]
queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional]
tags [str] Tags for generated signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: December 29, 2020
\ No newline at end of file + SecurityMonitoringRuleUpdatePayload - Datadog API Client for Python

SecurityMonitoringRuleUpdatePayload

Update an existing rule.

Properties

Name Type Description Notes
cases [SecurityMonitoringRuleCase] Cases for generating signals. [optional]
filters [SecurityMonitoringFilter] Additional queries to filter matched events before they are processed. [optional]
is_enabled bool Whether the rule is enabled. [optional]
message str Message for generated signals. [optional]
name str Name of the rule. [optional]
options SecurityMonitoringRuleOptions [optional]
queries [SecurityMonitoringRuleQuery] Queries for selecting logs which are part of the rule. [optional]
tags [str] Tags for generated signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignal/index.html b/v2/SecurityMonitoringSignal/index.html index f4a366a49a..a2af9b442f 100644 --- a/v2/SecurityMonitoringSignal/index.html +++ b/v2/SecurityMonitoringSignal/index.html @@ -1 +1 @@ - SecurityMonitoringSignal - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringSignal - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalAttributes/index.html b/v2/SecurityMonitoringSignalAttributes/index.html index 2b2af30962..ae601268f3 100644 --- a/v2/SecurityMonitoringSignalAttributes/index.html +++ b/v2/SecurityMonitoringSignalAttributes/index.html @@ -1 +1 @@ - SecurityMonitoringSignalAttributes - Datadog API Client for Python

SecurityMonitoringSignalAttributes

The object containing all signal attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional]
message str The message in the security signal defined by the rule that generated the signal. [optional]
tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional]
timestamp datetime The timestamp of the security signal. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: October 1, 2020
\ No newline at end of file + SecurityMonitoringSignalAttributes - Datadog API Client for Python

SecurityMonitoringSignalAttributes

The object containing all signal attributes and their associated values.

Properties

Name Type Description Notes
attributes {str: (bool, date, datetime, dict, float, int, list, str, none_type)} A JSON object of attributes in the security signal. [optional]
message str The message in the security signal defined by the rule that generated the signal. [optional]
tags [bool, date, datetime, dict, float, int, list, str, none_type] An array of tags associated with the security signal. [optional]
timestamp datetime The timestamp of the security signal. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalListRequest/index.html b/v2/SecurityMonitoringSignalListRequest/index.html index 3af55689fa..b290df6051 100644 --- a/v2/SecurityMonitoringSignalListRequest/index.html +++ b/v2/SecurityMonitoringSignalListRequest/index.html @@ -1 +1 @@ - SecurityMonitoringSignalListRequest - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringSignalListRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalListRequestFilter/index.html b/v2/SecurityMonitoringSignalListRequestFilter/index.html index 0070ab0cb6..53a2802857 100644 --- a/v2/SecurityMonitoringSignalListRequestFilter/index.html +++ b/v2/SecurityMonitoringSignalListRequestFilter/index.html @@ -1 +1 @@ - SecurityMonitoringSignalListRequestFilter - Datadog API Client for Python

SecurityMonitoringSignalListRequestFilter

Search filters for listing security signals.

Properties

Name Type Description Notes
_from datetime The minimum timestamp for requested security signals. [optional]
query str Search query for listing security signals. [optional]
to datetime The maximum timestamp for requested security signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringSignalListRequestFilter - Datadog API Client for Python

SecurityMonitoringSignalListRequestFilter

Search filters for listing security signals.

Properties

Name Type Description Notes
_from datetime The minimum timestamp for requested security signals. [optional]
query str Search query for listing security signals. [optional]
to datetime The maximum timestamp for requested security signals. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalListRequestPage/index.html b/v2/SecurityMonitoringSignalListRequestPage/index.html index 2ba1a3d029..e583d8f052 100644 --- a/v2/SecurityMonitoringSignalListRequestPage/index.html +++ b/v2/SecurityMonitoringSignalListRequestPage/index.html @@ -1 +1 @@ - SecurityMonitoringSignalListRequestPage - Datadog API Client for Python

SecurityMonitoringSignalListRequestPage

The paging attributes for listing security signals.

Properties

Name Type Description Notes
cursor str A list of results using the cursor provided in the previous query. [optional]
limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringSignalListRequestPage - Datadog API Client for Python

SecurityMonitoringSignalListRequestPage

The paging attributes for listing security signals.

Properties

Name Type Description Notes
cursor str A list of results using the cursor provided in the previous query. [optional]
limit int The maximum number of security signals in the response. [optional] if omitted the server will use the default value of 10

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalType/index.html b/v2/SecurityMonitoringSignalType/index.html index 1faa4703f8..a2d7bb7ff6 100644 --- a/v2/SecurityMonitoringSignalType/index.html +++ b/v2/SecurityMonitoringSignalType/index.html @@ -1 +1 @@ - SecurityMonitoringSignalType - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringSignalType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalsListResponse/index.html b/v2/SecurityMonitoringSignalsListResponse/index.html index 2e322fa0c9..10923809e2 100644 --- a/v2/SecurityMonitoringSignalsListResponse/index.html +++ b/v2/SecurityMonitoringSignalsListResponse/index.html @@ -1 +1 @@ - SecurityMonitoringSignalsListResponse - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringSignalsListResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalsListResponseLinks/index.html b/v2/SecurityMonitoringSignalsListResponseLinks/index.html index 256d10eebb..b3a94db1b4 100644 --- a/v2/SecurityMonitoringSignalsListResponseLinks/index.html +++ b/v2/SecurityMonitoringSignalsListResponseLinks/index.html @@ -1 +1 @@ - SecurityMonitoringSignalsListResponseLinks - Datadog API Client for Python

SecurityMonitoringSignalsListResponseLinks

Links attributes.

Properties

Name Type Description Notes
next str The link for the next set of results. Note: The request can also be made using the POST endpoint. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringSignalsListResponseLinks - Datadog API Client for Python

SecurityMonitoringSignalsListResponseLinks

Links attributes.

Properties

Name Type Description Notes
next str The link for the next set of results. Note: The request can also be made using the POST endpoint. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalsListResponseMeta/index.html b/v2/SecurityMonitoringSignalsListResponseMeta/index.html index f77ab94cfe..eec83d678a 100644 --- a/v2/SecurityMonitoringSignalsListResponseMeta/index.html +++ b/v2/SecurityMonitoringSignalsListResponseMeta/index.html @@ -1 +1 @@ - SecurityMonitoringSignalsListResponseMeta - Datadog API Client for Python
\ No newline at end of file + SecurityMonitoringSignalsListResponseMeta - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalsListResponseMetaPage/index.html b/v2/SecurityMonitoringSignalsListResponseMetaPage/index.html index d2ea80e4cd..4fbd6a23bd 100644 --- a/v2/SecurityMonitoringSignalsListResponseMetaPage/index.html +++ b/v2/SecurityMonitoringSignalsListResponseMetaPage/index.html @@ -1 +1 @@ - SecurityMonitoringSignalsListResponseMetaPage - Datadog API Client for Python

SecurityMonitoringSignalsListResponseMetaPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringSignalsListResponseMetaPage - Datadog API Client for Python

SecurityMonitoringSignalsListResponseMetaPage

Paging attributes.

Properties

Name Type Description Notes
after str The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/SecurityMonitoringSignalsSort/index.html b/v2/SecurityMonitoringSignalsSort/index.html index 34e26f5933..03774af34e 100644 --- a/v2/SecurityMonitoringSignalsSort/index.html +++ b/v2/SecurityMonitoringSignalsSort/index.html @@ -1 +1 @@ - SecurityMonitoringSignalsSort - Datadog API Client for Python

SecurityMonitoringSignalsSort

The sort parameters used for querying security signals.

Properties

Name Type Description Notes
value str The sort parameters used for querying security signals. must be one of ["timestamp", "-timestamp", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + SecurityMonitoringSignalsSort - Datadog API Client for Python

SecurityMonitoringSignalsSort

The sort parameters used for querying security signals.

Properties

Name Type Description Notes
value str The sort parameters used for querying security signals. must be one of ["timestamp", "-timestamp", ]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/User/index.html b/v2/User/index.html index 14b0ac5f75..058a91574f 100644 --- a/v2/User/index.html +++ b/v2/User/index.html @@ -1 +1 @@ - User - Datadog API Client for Python
\ No newline at end of file + User - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserAttributes/index.html b/v2/UserAttributes/index.html index ce9fce7388..34c250cbf2 100644 --- a/v2/UserAttributes/index.html +++ b/v2/UserAttributes/index.html @@ -1 +1 @@ - UserAttributes - Datadog API Client for Python

UserAttributes

Attributes of user object returned by the API.

Properties

Name Type Description Notes
created_at datetime Creation time of the user. [optional]
disabled bool Whether the user is disabled. [optional]
email str Email of the user. [optional]
handle str Handle of the user. [optional]
icon str URL of the user's icon. [optional]
name str Name of the user. [optional]
status str Status of the user. [optional]
title str Title of the user. [optional]
verified bool Whether the user is verified. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UserAttributes - Datadog API Client for Python

UserAttributes

Attributes of user object returned by the API.

Properties

Name Type Description Notes
created_at datetime Creation time of the user. [optional]
disabled bool Whether the user is disabled. [optional]
email str Email of the user. [optional]
handle str Handle of the user. [optional]
icon str URL of the user's icon. [optional]
name str Name of the user. [optional]
status str Status of the user. [optional]
title str Title of the user. [optional]
verified bool Whether the user is verified. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/UserCreateAttributes/index.html b/v2/UserCreateAttributes/index.html index 8fb4b016d9..5ee78fc3db 100644 --- a/v2/UserCreateAttributes/index.html +++ b/v2/UserCreateAttributes/index.html @@ -1 +1 @@ - UserCreateAttributes - Datadog API Client for Python

UserCreateAttributes

Attributes of the created user.

Properties

Name Type Description Notes
email str The email of the user.
name str The name of the user. [optional]
title str The title of the user. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 23, 2020
\ No newline at end of file + UserCreateAttributes - Datadog API Client for Python

UserCreateAttributes

Attributes of the created user.

Properties

Name Type Description Notes
email str The email of the user.
name str The name of the user. [optional]
title str The title of the user. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/UserCreateData/index.html b/v2/UserCreateData/index.html index 22bd3f2e48..edbbecec74 100644 --- a/v2/UserCreateData/index.html +++ b/v2/UserCreateData/index.html @@ -1 +1 @@ - UserCreateData - Datadog API Client for Python
\ No newline at end of file + UserCreateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserCreateRequest/index.html b/v2/UserCreateRequest/index.html index 08ce059bf5..e10d02f3b5 100644 --- a/v2/UserCreateRequest/index.html +++ b/v2/UserCreateRequest/index.html @@ -1 +1 @@ - UserCreateRequest - Datadog API Client for Python
\ No newline at end of file + UserCreateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationData/index.html b/v2/UserInvitationData/index.html index 0bba917f9c..6ddda1e76c 100644 --- a/v2/UserInvitationData/index.html +++ b/v2/UserInvitationData/index.html @@ -1 +1 @@ - UserInvitationData - Datadog API Client for Python
\ No newline at end of file + UserInvitationData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationDataAttributes/index.html b/v2/UserInvitationDataAttributes/index.html index eddb5b0cae..d100cf314f 100644 --- a/v2/UserInvitationDataAttributes/index.html +++ b/v2/UserInvitationDataAttributes/index.html @@ -1 +1 @@ - UserInvitationDataAttributes - Datadog API Client for Python

UserInvitationDataAttributes

Attributes of a user invitation.

Properties

Name Type Description Notes
created_at datetime Creation time of the user invitation. [optional]
expires_at datetime Time of invitation expiration. [optional]
invite_type str Type of invitation. [optional]
uuid str UUID of the user invitation. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UserInvitationDataAttributes - Datadog API Client for Python

UserInvitationDataAttributes

Attributes of a user invitation.

Properties

Name Type Description Notes
created_at datetime Creation time of the user invitation. [optional]
expires_at datetime Time of invitation expiration. [optional]
invite_type str Type of invitation. [optional]
uuid str UUID of the user invitation. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/UserInvitationRelationships/index.html b/v2/UserInvitationRelationships/index.html index d33bd63d32..4bba420e17 100644 --- a/v2/UserInvitationRelationships/index.html +++ b/v2/UserInvitationRelationships/index.html @@ -1 +1 @@ - UserInvitationRelationships - Datadog API Client for Python
\ No newline at end of file + UserInvitationRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationResponse/index.html b/v2/UserInvitationResponse/index.html index c052dcd4ca..8b7e7bd346 100644 --- a/v2/UserInvitationResponse/index.html +++ b/v2/UserInvitationResponse/index.html @@ -1 +1 @@ - UserInvitationResponse - Datadog API Client for Python
\ No newline at end of file + UserInvitationResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationResponseData/index.html b/v2/UserInvitationResponseData/index.html index 610444b032..48d87f550b 100644 --- a/v2/UserInvitationResponseData/index.html +++ b/v2/UserInvitationResponseData/index.html @@ -1 +1 @@ - UserInvitationResponseData - Datadog API Client for Python
\ No newline at end of file + UserInvitationResponseData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationsRequest/index.html b/v2/UserInvitationsRequest/index.html index c62b8af460..8754ef55f3 100644 --- a/v2/UserInvitationsRequest/index.html +++ b/v2/UserInvitationsRequest/index.html @@ -1 +1 @@ - UserInvitationsRequest - Datadog API Client for Python
\ No newline at end of file + UserInvitationsRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationsResponse/index.html b/v2/UserInvitationsResponse/index.html index d705eafdc1..546d2f6d20 100644 --- a/v2/UserInvitationsResponse/index.html +++ b/v2/UserInvitationsResponse/index.html @@ -1 +1 @@ - UserInvitationsResponse - Datadog API Client for Python
\ No newline at end of file + UserInvitationsResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserInvitationsType/index.html b/v2/UserInvitationsType/index.html index da01d0fb31..c734185836 100644 --- a/v2/UserInvitationsType/index.html +++ b/v2/UserInvitationsType/index.html @@ -1 +1 @@ - UserInvitationsType - Datadog API Client for Python
\ No newline at end of file + UserInvitationsType - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserRelationships/index.html b/v2/UserRelationships/index.html index ffd4c11fbc..1910a1780b 100644 --- a/v2/UserRelationships/index.html +++ b/v2/UserRelationships/index.html @@ -1 +1 @@ - UserRelationships - Datadog API Client for Python
\ No newline at end of file + UserRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserResponse/index.html b/v2/UserResponse/index.html index 53059ee257..2b9ad7b719 100644 --- a/v2/UserResponse/index.html +++ b/v2/UserResponse/index.html @@ -1 +1 @@ - UserResponse - Datadog API Client for Python
\ No newline at end of file + UserResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserResponseIncludedItem/index.html b/v2/UserResponseIncludedItem/index.html index 9f46d843a1..20cafdaa13 100644 --- a/v2/UserResponseIncludedItem/index.html +++ b/v2/UserResponseIncludedItem/index.html @@ -1 +1 @@ - UserResponseIncludedItem - Datadog API Client for Python
\ No newline at end of file + UserResponseIncludedItem - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserResponseRelationships/index.html b/v2/UserResponseRelationships/index.html index 9d8ad5afbf..b3ce2c5609 100644 --- a/v2/UserResponseRelationships/index.html +++ b/v2/UserResponseRelationships/index.html @@ -1 +1 @@ - UserResponseRelationships - Datadog API Client for Python
\ No newline at end of file + UserResponseRelationships - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserUpdateAttributes/index.html b/v2/UserUpdateAttributes/index.html index 3f0b4ef293..f56bb7d52b 100644 --- a/v2/UserUpdateAttributes/index.html +++ b/v2/UserUpdateAttributes/index.html @@ -1 +1 @@ - UserUpdateAttributes - Datadog API Client for Python

UserUpdateAttributes

Attributes of the edited user.

Properties

Name Type Description Notes
disabled bool If the user is enabled or disabled. [optional]
email str The email of the user. [optional]
name str The name of the user. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: September 1, 2020
\ No newline at end of file + UserUpdateAttributes - Datadog API Client for Python

UserUpdateAttributes

Attributes of the edited user.

Properties

Name Type Description Notes
disabled bool If the user is enabled or disabled. [optional]
email str The email of the user. [optional]
name str The name of the user. [optional]

[Back to Model list] [Back to API list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/UserUpdateData/index.html b/v2/UserUpdateData/index.html index 95a0c2f0f4..193b248acc 100644 --- a/v2/UserUpdateData/index.html +++ b/v2/UserUpdateData/index.html @@ -1 +1 @@ - UserUpdateData - Datadog API Client for Python
\ No newline at end of file + UserUpdateData - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UserUpdateRequest/index.html b/v2/UserUpdateRequest/index.html index 519e6ca88e..682013bbd5 100644 --- a/v2/UserUpdateRequest/index.html +++ b/v2/UserUpdateRequest/index.html @@ -1 +1 @@ - UserUpdateRequest - Datadog API Client for Python
\ No newline at end of file + UserUpdateRequest - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UsersApi/index.html b/v2/UsersApi/index.html index 0169f4f609..160c109ed0 100644 --- a/v2/UsersApi/index.html +++ b/v2/UsersApi/index.html @@ -323,4 +323,4 @@ pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->update_user: %s\n" % e) -

Parameters

Name Type Description Notes
user_id str The ID of the user.
body UserUpdateRequest

Return type

UserResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Not found -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: February 25, 2021
\ No newline at end of file +

Parameters

Name Type Description Notes
user_id str The ID of the user.
body UserUpdateRequest

Return type

UserResponse

Authorization

apiKeyAuth, appKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Authentication error -
404 Not found -
422 Unprocessable Entity -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Last update: March 23, 2021
\ No newline at end of file diff --git a/v2/UsersResponse/index.html b/v2/UsersResponse/index.html index cc238af0ca..ca79223348 100644 --- a/v2/UsersResponse/index.html +++ b/v2/UsersResponse/index.html @@ -1 +1 @@ - UsersResponse - Datadog API Client for Python
\ No newline at end of file + UsersResponse - Datadog API Client for Python
\ No newline at end of file diff --git a/v2/UsersType/index.html b/v2/UsersType/index.html index cd8e38ef2d..e171e9826a 100644 --- a/v2/UsersType/index.html +++ b/v2/UsersType/index.html @@ -1 +1 @@ - UsersType - Datadog API Client for Python
\ No newline at end of file + UsersType - Datadog API Client for Python
\ No newline at end of file