From a7303b383d95f872b17e2457d5e4498db83463c9 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Wed, 9 Oct 2024 09:02:51 +1000 Subject: [PATCH 1/9] Updated to usenode 22, updated dependencies & added prettier --- ansible/helloworld_playbook.yml | 0 package.json | 9 +- yarn.lock | 1004 ++++++++++++++++--------------- 3 files changed, 524 insertions(+), 489 deletions(-) create mode 100644 ansible/helloworld_playbook.yml diff --git a/ansible/helloworld_playbook.yml b/ansible/helloworld_playbook.yml new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json index 9ebd02e..ba383a2 100644 --- a/package.json +++ b/package.json @@ -28,13 +28,14 @@ "devDependencies": { "@eresearchqut/jest-testcontainers": "^3.4.0", "@types/jest": "^29.5.12", - "@types/node": "^20.14.10", + "@types/node": "^22.5.1", "dotenv": "^16.3.1", "jest": "^29.7.0", - "node-fetch": "^2.6.13", + "node-fetch": "^3.3.2", + "prettier": "^3.3.3", "rimraf": "^5.0.8", - "ts-jest": "^29.2.2", + "ts-jest": "29.2.5", "ts-node": "^10.9.2", - "typescript": "^5.5.3" + "typescript": "5.5.4" } } diff --git a/yarn.lock b/yarn.lock index eca83bf..b9a1784 100644 --- a/yarn.lock +++ b/yarn.lock @@ -10,159 +10,131 @@ "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.24" -"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.24.7.tgz#882fd9e09e8ee324e496bd040401c6f046ef4465" - integrity sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA== +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.25.7.tgz#438f2c524071531d643c6f0188e1e28f130cebc7" + integrity sha512-0xZJFNE5XMpENsgfHYTw8FbX4kv53mFLn2i3XPoq69LyhYSCBJtitaHx9QnsVTrsogI4Z3+HtEfZ2/GFPOtf5g== dependencies: - "@babel/highlight" "^7.24.7" + "@babel/highlight" "^7.25.7" picocolors "^1.0.0" -"@babel/compat-data@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.24.7.tgz#d23bbea508c3883ba8251fb4164982c36ea577ed" - integrity sha512-qJzAIcv03PyaWqxRgO4mSU3lihncDT296vnyuE2O8uA4w3UHWI4S3hgeZd1L8W1Bft40w9JxJ2b412iDUFFRhw== +"@babel/compat-data@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.25.7.tgz#b8479fe0018ef0ac87b6b7a5c6916fcd67ae2c9c" + integrity sha512-9ickoLz+hcXCeh7jrcin+/SLWm+GkxE2kTvoYyp38p4WkdFXfQJxDFGWp/YHjiKLPx06z2A7W8XKuqbReXDzsw== "@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.24.7.tgz#b676450141e0b52a3d43bc91da86aa608f950ac4" - integrity sha512-nykK+LEK86ahTkX/3TgauT0ikKoNCfKHEaZYTUVupJdTLzGNvrblu4u6fa7DhZONAltdf8e662t/abY8idrd/g== + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.25.7.tgz#1b3d144157575daf132a3bc80b2b18e6e3ca6ece" + integrity sha512-yJ474Zv3cwiSOO9nXJuqzvwEeM+chDuQ8GJirw+pZ91sCGCyOZ3dJkVE09fTV0VEVzXyLWhh3G/AolYTPX7Mow== dependencies: "@ampproject/remapping" "^2.2.0" - "@babel/code-frame" "^7.24.7" - "@babel/generator" "^7.24.7" - "@babel/helper-compilation-targets" "^7.24.7" - "@babel/helper-module-transforms" "^7.24.7" - "@babel/helpers" "^7.24.7" - "@babel/parser" "^7.24.7" - "@babel/template" "^7.24.7" - "@babel/traverse" "^7.24.7" - "@babel/types" "^7.24.7" + "@babel/code-frame" "^7.25.7" + "@babel/generator" "^7.25.7" + "@babel/helper-compilation-targets" "^7.25.7" + "@babel/helper-module-transforms" "^7.25.7" + "@babel/helpers" "^7.25.7" + "@babel/parser" "^7.25.7" + "@babel/template" "^7.25.7" + "@babel/traverse" "^7.25.7" + "@babel/types" "^7.25.7" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.24.7", "@babel/generator@^7.7.2": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.24.7.tgz#1654d01de20ad66b4b4d99c135471bc654c55e6d" - integrity sha512-oipXieGC3i45Y1A41t4tAqpnEZWgB/lC6Ehh6+rOviR5XWpTtMmLN+fGjz9vOiNRt0p6RtO6DtD0pdU3vpqdSA== +"@babel/generator@^7.25.7", "@babel/generator@^7.7.2": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.25.7.tgz#de86acbeb975a3e11ee92dd52223e6b03b479c56" + integrity sha512-5Dqpl5fyV9pIAD62yK9P7fcA768uVPUyrQmqpqstHWgMma4feF1x/oFysBCVZLY5wJ2GkMUCdsNDnGZrPoR6rA== dependencies: - "@babel/types" "^7.24.7" + "@babel/types" "^7.25.7" "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" - jsesc "^2.5.1" + jsesc "^3.0.2" -"@babel/helper-compilation-targets@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.24.7.tgz#4eb6c4a80d6ffeac25ab8cd9a21b5dfa48d503a9" - integrity sha512-ctSdRHBi20qWOfy27RUb4Fhp07KSJ3sXcuSvTrXrc4aG8NSYDo1ici3Vhg9bg69y5bj0Mr1lh0aeEgTvc12rMg== +"@babel/helper-compilation-targets@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.25.7.tgz#11260ac3322dda0ef53edfae6e97b961449f5fa4" + integrity sha512-DniTEax0sv6isaw6qSQSfV4gVRNtw2rte8HHM45t9ZR0xILaufBRNkpMifCRiAPyvL4ACD6v0gfCwCmtOQaV4A== dependencies: - "@babel/compat-data" "^7.24.7" - "@babel/helper-validator-option" "^7.24.7" - browserslist "^4.22.2" + "@babel/compat-data" "^7.25.7" + "@babel/helper-validator-option" "^7.25.7" + browserslist "^4.24.0" lru-cache "^5.1.1" semver "^6.3.1" -"@babel/helper-environment-visitor@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-environment-visitor/-/helper-environment-visitor-7.24.7.tgz#4b31ba9551d1f90781ba83491dd59cf9b269f7d9" - integrity sha512-DoiN84+4Gnd0ncbBOM9AZENV4a5ZiL39HYMyZJGZ/AZEykHYdJw0wW3kdcsh9/Kn+BRXHLkkklZ51ecPKmI1CQ== - dependencies: - "@babel/types" "^7.24.7" - -"@babel/helper-function-name@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-function-name/-/helper-function-name-7.24.7.tgz#75f1e1725742f39ac6584ee0b16d94513da38dd2" - integrity sha512-FyoJTsj/PEUWu1/TYRiXTIHc8lbw+TDYkZuoE43opPS5TrI7MyONBE1oNvfguEXAD9yhQRrVBnXdXzSLQl9XnA== - dependencies: - "@babel/template" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/helper-hoist-variables@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-hoist-variables/-/helper-hoist-variables-7.24.7.tgz#b4ede1cde2fd89436397f30dc9376ee06b0f25ee" - integrity sha512-MJJwhkoGy5c4ehfoRyrJ/owKeMl19U54h27YYftT0o2teQ3FJ3nQUf/I3LlJsX4l3qlw7WRXUmiyajvHXoTubQ== - dependencies: - "@babel/types" "^7.24.7" - -"@babel/helper-module-imports@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.24.7.tgz#f2f980392de5b84c3328fc71d38bd81bbb83042b" - integrity sha512-8AyH3C+74cgCVVXow/myrynrAGv+nTVg5vKu2nZph9x7RcRwzmh0VFallJuFTZ9mx6u4eSdXZfcOzSqTUm0HCA== - dependencies: - "@babel/traverse" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/helper-module-transforms@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.24.7.tgz#31b6c9a2930679498db65b685b1698bfd6c7daf8" - integrity sha512-1fuJEwIrp+97rM4RWdO+qrRsZlAeL1lQJoPqtCYWv0NL115XM93hIH4CSRln2w52SqvmY5hqdtauB6QFCDiZNQ== - dependencies: - "@babel/helper-environment-visitor" "^7.24.7" - "@babel/helper-module-imports" "^7.24.7" - "@babel/helper-simple-access" "^7.24.7" - "@babel/helper-split-export-declaration" "^7.24.7" - "@babel/helper-validator-identifier" "^7.24.7" - -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.24.7", "@babel/helper-plugin-utils@^7.8.0": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.24.7.tgz#98c84fe6fe3d0d3ae7bfc3a5e166a46844feb2a0" - integrity sha512-Rq76wjt7yz9AAc1KnlRKNAi/dMSVWgDRx43FHoJEbcYU6xOWaE2dVPwcdTukJrjxS65GITyfbvEYHvkirZ6uEg== - -"@babel/helper-simple-access@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.24.7.tgz#bcade8da3aec8ed16b9c4953b74e506b51b5edb3" - integrity sha512-zBAIvbCMh5Ts+b86r/CjU+4XGYIs+R1j951gxI3KmmxBMhCg4oQMsv6ZXQ64XOm/cvzfU1FmoCyt6+owc5QMYg== - dependencies: - "@babel/traverse" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/helper-split-export-declaration@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.24.7.tgz#83949436890e07fa3d6873c61a96e3bbf692d856" - integrity sha512-oy5V7pD+UvfkEATUKvIjvIAH/xCzfsFVw7ygW2SI6NClZzquT+mwdTfgfdbUiceh6iQO0CHtCPsyze/MZ2YbAA== - dependencies: - "@babel/types" "^7.24.7" - -"@babel/helper-string-parser@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.24.7.tgz#4d2d0f14820ede3b9807ea5fc36dfc8cd7da07f2" - integrity sha512-7MbVt6xrwFQbunH2DNQsAP5sTGxfqQtErvBIvIMi6EQnbgUOuVYanvREcmFrOPhoXBrTtjhhP+lW+o5UfK+tDg== - -"@babel/helper-validator-identifier@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz#75b889cfaf9e35c2aaf42cf0d72c8e91719251db" - integrity sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w== - -"@babel/helper-validator-option@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.24.7.tgz#24c3bb77c7a425d1742eec8fb433b5a1b38e62f6" - integrity sha512-yy1/KvjhV/ZCL+SM7hBrvnZJ3ZuT9OuZgIJAGpPEToANvc3iM6iDvBnRjtElWibHU6n8/LPR/EjX9EtIEYO3pw== - -"@babel/helpers@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.24.7.tgz#aa2ccda29f62185acb5d42fb4a3a1b1082107416" - integrity sha512-NlmJJtvcw72yRJRcnCmGvSi+3jDEg8qFu3z0AFoymmzLx5ERVWyzd9kVXr7Th9/8yIJi2Zc6av4Tqz3wFs8QWg== - dependencies: - "@babel/template" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/highlight@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.24.7.tgz#a05ab1df134b286558aae0ed41e6c5f731bf409d" - integrity sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw== - dependencies: - "@babel/helper-validator-identifier" "^7.24.7" +"@babel/helper-module-imports@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.25.7.tgz#dba00d9523539152906ba49263e36d7261040472" + integrity sha512-o0xCgpNmRohmnoWKQ0Ij8IdddjyBFE4T2kagL/x6M3+4zUgc+4qTOUBoNe4XxDskt1HPKO007ZPiMgLDq2s7Kw== + dependencies: + "@babel/traverse" "^7.25.7" + "@babel/types" "^7.25.7" + +"@babel/helper-module-transforms@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.25.7.tgz#2ac9372c5e001b19bc62f1fe7d96a18cb0901d1a" + integrity sha512-k/6f8dKG3yDz/qCwSM+RKovjMix563SLxQFo0UhRNo239SP6n9u5/eLtKD6EAjwta2JHJ49CsD8pms2HdNiMMQ== + dependencies: + "@babel/helper-module-imports" "^7.25.7" + "@babel/helper-simple-access" "^7.25.7" + "@babel/helper-validator-identifier" "^7.25.7" + "@babel/traverse" "^7.25.7" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.25.7", "@babel/helper-plugin-utils@^7.8.0": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.25.7.tgz#8ec5b21812d992e1ef88a9b068260537b6f0e36c" + integrity sha512-eaPZai0PiqCi09pPs3pAFfl/zYgGaE6IdXtYvmf0qlcDTd3WCtO7JWCcRd64e0EQrcYgiHibEZnOGsSY4QSgaw== + +"@babel/helper-simple-access@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.25.7.tgz#5eb9f6a60c5d6b2e0f76057004f8dacbddfae1c0" + integrity sha512-FPGAkJmyoChQeM+ruBGIDyrT2tKfZJO8NcxdC+CWNJi7N8/rZpSxK7yvBJ5O/nF1gfu5KzN7VKG3YVSLFfRSxQ== + dependencies: + "@babel/traverse" "^7.25.7" + "@babel/types" "^7.25.7" + +"@babel/helper-string-parser@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.25.7.tgz#d50e8d37b1176207b4fe9acedec386c565a44a54" + integrity sha512-CbkjYdsJNHFk8uqpEkpCvRs3YRp9tY6FmFY7wLMSYuGYkrdUi7r2lc4/wqsvlHoMznX3WJ9IP8giGPq68T/Y6g== + +"@babel/helper-validator-identifier@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.7.tgz#77b7f60c40b15c97df735b38a66ba1d7c3e93da5" + integrity sha512-AM6TzwYqGChO45oiuPqwL2t20/HdMC1rTPAesnBCgPCSF1x3oN9MVUwQV2iyz4xqWrctwK5RNC8LV22kaQCNYg== + +"@babel/helper-validator-option@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.25.7.tgz#97d1d684448228b30b506d90cace495d6f492729" + integrity sha512-ytbPLsm+GjArDYXJ8Ydr1c/KJuutjF2besPNbIZnZ6MKUxi/uTA22t2ymmA4WFjZFpjiAMO0xuuJPqK2nvDVfQ== + +"@babel/helpers@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.25.7.tgz#091b52cb697a171fe0136ab62e54e407211f09c2" + integrity sha512-Sv6pASx7Esm38KQpF/U/OXLwPPrdGHNKoeblRxgZRLXnAtnkEe4ptJPDtAZM7fBLadbc1Q07kQpSiGQ0Jg6tRA== + dependencies: + "@babel/template" "^7.25.7" + "@babel/types" "^7.25.7" + +"@babel/highlight@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.25.7.tgz#20383b5f442aa606e7b5e3043b0b1aafe9f37de5" + integrity sha512-iYyACpW3iW8Fw+ZybQK+drQre+ns/tKpXbNESfrhNnPLIklLbXr7MYJ6gPEd0iETGLOK+SxMjVvKb/ffmk+FEw== + dependencies: + "@babel/helper-validator-identifier" "^7.25.7" chalk "^2.4.2" js-tokens "^4.0.0" picocolors "^1.0.0" -"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.24.7.tgz#9a5226f92f0c5c8ead550b750f5608e766c8ce85" - integrity sha512-9uUYRm6OqQrCqQdG1iCBwBPZgN8ciDBro2nIOFaiRz1/BCxaI7CNvQbDHvsArAC7Tw9Hda/B3U+6ui9u4HWXPw== +"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.25.7.tgz#99b927720f4ddbfeb8cd195a363ed4532f87c590" + integrity sha512-aZn7ETtQsjjGG5HruveUK06cU3Hljuhd9Iojm4M8WWv3wLE6OkE5PWbDUkItmMgegmccaITudyuW5RPYrYlgWw== + dependencies: + "@babel/types" "^7.25.7" "@babel/plugin-syntax-async-generators@^7.8.4": version "7.8.4" @@ -178,14 +150,28 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.0" -"@babel/plugin-syntax-class-properties@^7.8.3": +"@babel/plugin-syntax-class-properties@^7.12.13": version "7.12.13" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz#b5c987274c4a3a82b89714796931a6b53544ae10" integrity sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA== dependencies: "@babel/helper-plugin-utils" "^7.12.13" -"@babel/plugin-syntax-import-meta@^7.8.3": +"@babel/plugin-syntax-class-static-block@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz#195df89b146b4b78b3bf897fd7a257c84659d406" + integrity sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-import-attributes@^7.24.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.25.7.tgz#d78dd0499d30df19a598e63ab895e21b909bc43f" + integrity sha512-AqVo+dguCgmpi/3mYBdu9lkngOBlQ2w2vnNpa6gfiCxQZLzV4ZbhsXitJ2Yblkoe1VQwtHSaNmIaGll/26YWRw== + dependencies: + "@babel/helper-plugin-utils" "^7.25.7" + +"@babel/plugin-syntax-import-meta@^7.10.4": version "7.10.4" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz#ee601348c370fa334d2207be158777496521fd51" integrity sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g== @@ -200,13 +186,13 @@ "@babel/helper-plugin-utils" "^7.8.0" "@babel/plugin-syntax-jsx@^7.7.2": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.24.7.tgz#39a1fa4a7e3d3d7f34e2acc6be585b718d30e02d" - integrity sha512-6ddciUPe/mpMnOKv/U+RSd2vvVy+Yw/JfBB0ZHYjEZt9NLHmCUylNYlsbqCCS1Bffjlb0fCwC9Vqz+sBz6PsiQ== + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.25.7.tgz#5352d398d11ea5e7ef330c854dea1dae0bf18165" + integrity sha512-ruZOnKO+ajVL/MVx+PwNBPOkrnXTXoWMtte1MBpegfCArhqOe3Bj52avVj1huLLxNKYKXYaSxZ2F+woK1ekXfw== dependencies: - "@babel/helper-plugin-utils" "^7.24.7" + "@babel/helper-plugin-utils" "^7.25.7" -"@babel/plugin-syntax-logical-assignment-operators@^7.8.3": +"@babel/plugin-syntax-logical-assignment-operators@^7.10.4": version "7.10.4" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz#ca91ef46303530448b906652bac2e9fe9941f699" integrity sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig== @@ -220,7 +206,7 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.0" -"@babel/plugin-syntax-numeric-separator@^7.8.3": +"@babel/plugin-syntax-numeric-separator@^7.10.4": version "7.10.4" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz#b9b070b3e33570cd9fd07ba7fa91c0dd37b9af97" integrity sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug== @@ -248,7 +234,14 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.0" -"@babel/plugin-syntax-top-level-await@^7.8.3": +"@babel/plugin-syntax-private-property-in-object@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz#0dc6671ec0ea22b6e94a1114f857970cd39de1ad" + integrity sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-top-level-await@^7.14.5": version "7.14.5" resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz#c1cfdadc35a646240001f06138247b741c34d94c" integrity sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw== @@ -256,44 +249,41 @@ "@babel/helper-plugin-utils" "^7.14.5" "@babel/plugin-syntax-typescript@^7.7.2": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.24.7.tgz#58d458271b4d3b6bb27ee6ac9525acbb259bad1c" - integrity sha512-c/+fVeJBB0FeKsFvwytYiUD+LBvhHjGSI0g446PRGdSVGZLRNArBUno2PETbAly3tpiNAQR5XaZ+JslxkotsbA== - dependencies: - "@babel/helper-plugin-utils" "^7.24.7" - -"@babel/template@^7.24.7", "@babel/template@^7.3.3": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.24.7.tgz#02efcee317d0609d2c07117cb70ef8fb17ab7315" - integrity sha512-jYqfPrU9JTF0PmPy1tLYHW4Mp4KlgxJD9l2nP9fD6yT/ICi554DmrWBAEYpIelzjHf1msDP3PxJIRt/nFNfBig== - dependencies: - "@babel/code-frame" "^7.24.7" - "@babel/parser" "^7.24.7" - "@babel/types" "^7.24.7" - -"@babel/traverse@^7.24.7": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.24.7.tgz#de2b900163fa741721ba382163fe46a936c40cf5" - integrity sha512-yb65Ed5S/QAcewNPh0nZczy9JdYXkkAbIsEo+P7BE7yO3txAY30Y/oPa3QkQ5It3xVG2kpKMg9MsdxZaO31uKA== - dependencies: - "@babel/code-frame" "^7.24.7" - "@babel/generator" "^7.24.7" - "@babel/helper-environment-visitor" "^7.24.7" - "@babel/helper-function-name" "^7.24.7" - "@babel/helper-hoist-variables" "^7.24.7" - "@babel/helper-split-export-declaration" "^7.24.7" - "@babel/parser" "^7.24.7" - "@babel/types" "^7.24.7" + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.7.tgz#bfc05b0cc31ebd8af09964650cee723bb228108b" + integrity sha512-rR+5FDjpCHqqZN2bzZm18bVYGaejGq5ZkpVCJLXor/+zlSrSoc4KWcHI0URVWjl/68Dyr1uwZUz/1njycEAv9g== + dependencies: + "@babel/helper-plugin-utils" "^7.25.7" + +"@babel/template@^7.25.7", "@babel/template@^7.3.3": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.25.7.tgz#27f69ce382855d915b14ab0fe5fb4cbf88fa0769" + integrity sha512-wRwtAgI3bAS+JGU2upWNL9lSlDcRCqD05BZ1n3X2ONLH1WilFP6O1otQjeMK/1g0pvYcXC7b/qVUB1keofjtZA== + dependencies: + "@babel/code-frame" "^7.25.7" + "@babel/parser" "^7.25.7" + "@babel/types" "^7.25.7" + +"@babel/traverse@^7.25.7": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.25.7.tgz#83e367619be1cab8e4f2892ef30ba04c26a40fa8" + integrity sha512-jatJPT1Zjqvh/1FyJs6qAHL+Dzb7sTb+xr7Q+gM1b+1oBsMsQQ4FkVKb6dFlJvLlVssqkRzV05Jzervt9yhnzg== + dependencies: + "@babel/code-frame" "^7.25.7" + "@babel/generator" "^7.25.7" + "@babel/parser" "^7.25.7" + "@babel/template" "^7.25.7" + "@babel/types" "^7.25.7" debug "^4.3.1" globals "^11.1.0" -"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.24.7", "@babel/types@^7.3.3": - version "7.24.7" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.24.7.tgz#6027fe12bc1aa724cd32ab113fb7f1988f1f66f2" - integrity sha512-XEFXSlxiG5td2EJRe8vOmRbaXVgfcBlszKujvVmWIK/UpywWljQCfzAv3RQCGujWQ1RD4YYWEAqDXfuJiy8f5Q== +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.25.7", "@babel/types@^7.3.3": + version "7.25.7" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.25.7.tgz#1b7725c1d3a59f328cb700ce704c46371e6eef9b" + integrity sha512-vwIVdXG+j+FOpkwqHRcBgHLYNL7XMkufrlaFvL9o6Ai9sJn9+PdyIL5qa0XzTZw084c+u9LOls53eoZWP/W5WQ== dependencies: - "@babel/helper-string-parser" "^7.24.7" - "@babel/helper-validator-identifier" "^7.24.7" + "@babel/helper-string-parser" "^7.25.7" + "@babel/helper-validator-identifier" "^7.25.7" to-fast-properties "^2.0.0" "@balena/dockerignore@^1.0.2": @@ -314,12 +304,18 @@ "@jridgewell/trace-mapping" "0.3.9" "@eresearchqut/jest-testcontainers@^3.4.0": - version "3.4.0" - resolved "https://registry.yarnpkg.com/@eresearchqut/jest-testcontainers/-/jest-testcontainers-3.4.0.tgz#48ce16506e5d4101d91893f0c1eec3fb44708134" - integrity sha512-kd0ajQCqCMKz+8BKigJwUrTbqyu+SOrdX+q4udA0EUUpY1V3A/nrLCOt7VbC2PiovWZ0DBLakpmvKGG4OAWbLA== + version "3.6.4" + resolved "https://npm.pkg.github.com/download/@eresearchqut/jest-testcontainers/3.6.4/dd8077ee9c871e820d849f41f2548ac96486b587#dd8077ee9c871e820d849f41f2548ac96486b587" + integrity sha512-flWCEEpnAG2MX9ZKe+y/m+evYW2bqeD5Cbt4Uf6lpt430Wnvb3u2R4Ebv97ubhUPU10HezK1kJA+UxClCNlsrg== dependencies: cwd "^0.10.0" - testcontainers "10.9.0" + debug "^4.3.5" + testcontainers "10.13.1" + +"@fastify/busboy@^2.0.0": + version "2.1.1" + resolved "https://registry.yarnpkg.com/@fastify/busboy/-/busboy-2.1.1.tgz#b9da6a878a371829a0502c9b6c1c143ef6663f4d" + integrity sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA== "@isaacs/cliui@^8.0.2": version "8.0.2" @@ -561,9 +557,9 @@ integrity sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A== "@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14": - version "1.4.15" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz#d7c6e6755c78567a951e04ab52ef0fd26de59f32" - integrity sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg== + version "1.5.0" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a" + integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ== "@jridgewell/trace-mapping@0.3.9": version "0.3.9" @@ -666,10 +662,10 @@ "@types/node" "*" "@types/ssh2" "*" -"@types/dockerode@^3.3.24": - version "3.3.29" - resolved "https://registry.yarnpkg.com/@types/dockerode/-/dockerode-3.3.29.tgz#7d3c99a91c381115015587a8a2a71002029e1740" - integrity sha512-5PRRq/yt5OT/Jf77ltIdz4EiR9+VLnPF+HpU4xGFwUqmV24Co2HKBNW3w+slqZ1CYchbcDeqJASHDYWzZCcMiQ== +"@types/dockerode@^3.3.29": + version "3.3.31" + resolved "https://registry.yarnpkg.com/@types/dockerode/-/dockerode-3.3.31.tgz#27a192c134651d85afc658e4d3e7a805b865989e" + integrity sha512-42R9eoVqJDSvVspV89g7RwRqfNExgievLNWoHkg7NoWIqAmavIbgQBb4oc0qRtHkxE+I3Xxvqv7qVXFABKPBTg== dependencies: "@types/docker-modem" "*" "@types/node" "*" @@ -702,24 +698,24 @@ "@types/istanbul-lib-report" "*" "@types/jest@^29.5.12": - version "29.5.12" - resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.12.tgz#7f7dc6eb4cf246d2474ed78744b05d06ce025544" - integrity sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw== + version "29.5.13" + resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.13.tgz#8bc571659f401e6a719a7bf0dbcb8b78c71a8adc" + integrity sha512-wd+MVEZCHt23V0/L642O5APvspWply/rGY5BcW4SUETo2UzPU3Z26qr8jC2qxpimI2jjx9h7+2cj2FwIr01bXg== dependencies: expect "^29.0.0" pretty-format "^29.0.0" -"@types/node@*", "@types/node@^20.14.10": - version "20.14.10" - resolved "https://registry.yarnpkg.com/@types/node/-/node-20.14.10.tgz#a1a218290f1b6428682e3af044785e5874db469a" - integrity sha512-MdiXf+nDuMvY0gJKxyfZ7/6UFsETO7mGKF54MVD/ekJS6HdFtpZFBgrh6Pseu64XTb2MLyFPlbW6hj8HYRQNOQ== +"@types/node@*", "@types/node@^22.5.1": + version "22.7.5" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.7.5.tgz#cfde981727a7ab3611a481510b473ae54442b92b" + integrity sha512-jML7s2NAzMWc//QSJ1a3prpk78cOPchGvXJsC3C6R6PSMoooztvRVQEz89gmBTBY1SPMaqo5teB4uNHPdetShQ== dependencies: - undici-types "~5.26.4" + undici-types "~6.19.2" "@types/node@^18.11.18": - version "18.19.39" - resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.39.tgz#c316340a5b4adca3aee9dcbf05de385978590593" - integrity sha512-nPwTRDKUctxw3di5b4TfT3I0sWDiWoPQCZjXhvdkINntwr8lcoVCKsTgnXeRubKIlfnV+eN/HYk6Jb40tbcEAQ== + version "18.19.55" + resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.55.tgz#29c3f8e1485a92ec96636957ddec55aabc6e856e" + integrity sha512-zzw5Vw52205Zr/nmErSEkN5FLqXPuKX/k5d1D7RKHATGqU7y6YfX9QxZraUzUrFGqH6XzOzG196BC35ltJC4Cw== dependencies: undici-types "~5.26.4" @@ -731,9 +727,9 @@ "@types/node" "*" "@types/ssh2@*": - version "1.15.0" - resolved "https://registry.yarnpkg.com/@types/ssh2/-/ssh2-1.15.0.tgz#ef698a2fe05696d898e0f9398384ad370cd35317" - integrity sha512-YcT8jP5F8NzWeevWvcyrrLB3zcneVjzYY9ZDSMAMboI+2zR1qYWFhwsyOFVzT7Jorn67vqxC0FRiw8YyG9P1ww== + version "1.15.1" + resolved "https://registry.yarnpkg.com/@types/ssh2/-/ssh2-1.15.1.tgz#4db4b6864abca09eb299fe5354fa591add412223" + integrity sha512-ZIbEqKAsi5gj35y4P4vkJYly642wIbY6PqoN0xiyQGshKUGXR9WQjF/iF9mXBQ8uBKy3ezfsCkcoHKhd0BzuDA== dependencies: "@types/node" "^18.11.18" @@ -756,16 +752,23 @@ integrity sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ== "@types/yargs@^17.0.8": - version "17.0.32" - resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.32.tgz#030774723a2f7faafebf645f4e5a48371dca6229" - integrity sha512-xQ67Yc/laOG5uMfX/093MRlGGCIBzZMarVa+gfNKJxWAIgykYpVGkBdbqEzGDDfCrVUj6Hiff4mTZ5BA6TmAog== + version "17.0.33" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.33.tgz#8c32303da83eec050a84b3c7ae7b9f922d13e32d" + integrity sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA== dependencies: "@types/yargs-parser" "*" +abort-controller@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/abort-controller/-/abort-controller-3.0.0.tgz#eaf54d53b62bae4138e809ca225c8439a6efb392" + integrity sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg== + dependencies: + event-target-shim "^5.0.0" + acorn-walk@^8.1.1: - version "8.3.3" - resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.3.tgz#9caeac29eefaa0c41e3d4c65137de4d6f34df43e" - integrity sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw== + version "8.3.4" + resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7" + integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g== dependencies: acorn "^8.11.0" @@ -787,9 +790,9 @@ ansi-regex@^5.0.1: integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== ansi-regex@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a" - integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== + version "6.1.0" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.1.0.tgz#95ec409c69619d6cb1b8b34f14b660ef28ebd654" + integrity sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA== ansi-styles@^3.2.1: version "3.2.1" @@ -823,50 +826,31 @@ anymatch@^3.0.3: normalize-path "^3.0.0" picomatch "^2.0.4" -archiver-utils@^2.1.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/archiver-utils/-/archiver-utils-2.1.0.tgz#e8a460e94b693c3e3da182a098ca6285ba9249e2" - integrity sha512-bEL/yUb/fNNiNTuUz979Z0Yg5L+LzLxGJz8x79lYmR54fmTIb6ob/hNQgkQnIUDWIFjZVQwl9Xs356I6BAMHfw== +archiver-utils@^5.0.0, archiver-utils@^5.0.2: + version "5.0.2" + resolved "https://registry.yarnpkg.com/archiver-utils/-/archiver-utils-5.0.2.tgz#63bc719d951803efc72cf961a56ef810760dd14d" + integrity sha512-wuLJMmIBQYCsGZgYLTy5FIB2pF6Lfb6cXMSF8Qywwk3t20zWnAi7zLcQFdKQmIB8wyZpY5ER38x08GbwtR2cLA== dependencies: - glob "^7.1.4" + glob "^10.0.0" graceful-fs "^4.2.0" + is-stream "^2.0.1" lazystream "^1.0.0" - lodash.defaults "^4.2.0" - lodash.difference "^4.5.0" - lodash.flatten "^4.4.0" - lodash.isplainobject "^4.0.6" - lodash.union "^4.6.0" + lodash "^4.17.15" normalize-path "^3.0.0" - readable-stream "^2.0.0" + readable-stream "^4.0.0" -archiver-utils@^3.0.4: - version "3.0.4" - resolved "https://registry.yarnpkg.com/archiver-utils/-/archiver-utils-3.0.4.tgz#a0d201f1cf8fce7af3b5a05aea0a337329e96ec7" - integrity sha512-KVgf4XQVrTjhyWmx6cte4RxonPLR9onExufI1jhvw/MQ4BB6IsZD5gT8Lq+u/+pRkWna/6JoHpiQioaqFP5Rzw== +archiver@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/archiver/-/archiver-7.0.1.tgz#c9d91c350362040b8927379c7aa69c0655122f61" + integrity sha512-ZcbTaIqJOfCc03QwD468Unz/5Ir8ATtvAHsK+FdXbDIbGfihqh9mrvdcYunQzqn4HrvWWaFyaxJhGZagaJJpPQ== dependencies: - glob "^7.2.3" - graceful-fs "^4.2.0" - lazystream "^1.0.0" - lodash.defaults "^4.2.0" - lodash.difference "^4.5.0" - lodash.flatten "^4.4.0" - lodash.isplainobject "^4.0.6" - lodash.union "^4.6.0" - normalize-path "^3.0.0" - readable-stream "^3.6.0" - -archiver@^5.3.2: - version "5.3.2" - resolved "https://registry.yarnpkg.com/archiver/-/archiver-5.3.2.tgz#99991d5957e53bd0303a392979276ac4ddccf3b0" - integrity sha512-+25nxyyznAXF7Nef3y0EbBeqmGZgeN/BxHX29Rs39djAfaFalmQ89SE6CWyDCHzGL0yt/ycBtNOmGTW0FyGWNw== - dependencies: - archiver-utils "^2.1.0" + archiver-utils "^5.0.2" async "^3.2.4" - buffer-crc32 "^0.2.1" - readable-stream "^3.6.0" + buffer-crc32 "^1.0.0" + readable-stream "^4.0.0" readdir-glob "^1.1.2" - tar-stream "^2.2.0" - zip-stream "^4.1.0" + tar-stream "^3.0.0" + zip-stream "^6.0.1" arg@^4.1.0: version "4.1.3" @@ -893,17 +877,17 @@ async-lock@^1.4.1: integrity sha512-Az2ZTpuytrtqENulXwO3GGv1Bztugx6TT37NIo7imr/Qo0gsYiGtSdBa2B6fsXhTpVZDNfu1Qn3pk531e3q+nQ== async@^3.2.3, async@^3.2.4: - version "3.2.5" - resolved "https://registry.yarnpkg.com/async/-/async-3.2.5.tgz#ebd52a8fdaf7a2289a24df399f8d8485c8a46b66" - integrity sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg== + version "3.2.6" + resolved "https://registry.yarnpkg.com/async/-/async-3.2.6.tgz#1b0728e14929d51b85b449b7f06e27c1145e38ce" + integrity sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA== awx-api-client@./typescript-fetch-client: version "1.0.0" -b4a@^1.6.4: - version "1.6.6" - resolved "https://registry.yarnpkg.com/b4a/-/b4a-1.6.6.tgz#a4cc349a3851987c3c4ac2d7785c18744f6da9ba" - integrity sha512-5Tk1HLk6b6ctmjIkAcU/Ujv/1WqiDl0F0JdRCR80VsOcUlHcu7pWeWRlOqQLHfDEsVx9YH/aif5AG4ehoCtTmg== +b4a@^1.6.4, b4a@^1.6.6: + version "1.6.7" + resolved "https://registry.yarnpkg.com/b4a/-/b4a-1.6.7.tgz#a99587d4ebbfbd5a6e3b21bdb5d5fa385767abe4" + integrity sha512-OnAYlL5b7LEkALw87fUVafQw5rVR9RjwGd4KUwNQ6DrrNmaVaUCgLipfVlzrPQ4tWOR9P0IXGNOx50jYCCdSJg== babel-jest@^29.7.0: version "29.7.0" @@ -940,22 +924,25 @@ babel-plugin-jest-hoist@^29.6.3: "@types/babel__traverse" "^7.0.6" babel-preset-current-node-syntax@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.0.1.tgz#b4399239b89b2a011f9ddbe3e4f401fc40cff73b" - integrity sha512-M7LQ0bxarkxQoN+vz5aJPsLBn77n8QgTFmo8WK0/44auK2xlCXrYcUxHFxgU7qW5Yzw/CjmLRK2uJzaCd7LvqQ== + version "1.1.0" + resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz#9a929eafece419612ef4ae4f60b1862ebad8ef30" + integrity sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw== dependencies: "@babel/plugin-syntax-async-generators" "^7.8.4" "@babel/plugin-syntax-bigint" "^7.8.3" - "@babel/plugin-syntax-class-properties" "^7.8.3" - "@babel/plugin-syntax-import-meta" "^7.8.3" + "@babel/plugin-syntax-class-properties" "^7.12.13" + "@babel/plugin-syntax-class-static-block" "^7.14.5" + "@babel/plugin-syntax-import-attributes" "^7.24.7" + "@babel/plugin-syntax-import-meta" "^7.10.4" "@babel/plugin-syntax-json-strings" "^7.8.3" - "@babel/plugin-syntax-logical-assignment-operators" "^7.8.3" + "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.3" - "@babel/plugin-syntax-numeric-separator" "^7.8.3" + "@babel/plugin-syntax-numeric-separator" "^7.10.4" "@babel/plugin-syntax-object-rest-spread" "^7.8.3" "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" "@babel/plugin-syntax-optional-chaining" "^7.8.3" - "@babel/plugin-syntax-top-level-await" "^7.8.3" + "@babel/plugin-syntax-private-property-in-object" "^7.14.5" + "@babel/plugin-syntax-top-level-await" "^7.14.5" babel-preset-jest@^29.6.3: version "29.6.3" @@ -971,23 +958,23 @@ balanced-match@^1.0.0: integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== bare-events@^2.0.0, bare-events@^2.2.0: - version "2.4.2" - resolved "https://registry.yarnpkg.com/bare-events/-/bare-events-2.4.2.tgz#3140cca7a0e11d49b3edc5041ab560659fd8e1f8" - integrity sha512-qMKFd2qG/36aA4GwvKq8MxnPgCQAmBWmSyLWsJcbn8v03wvIPQ/hG1Ms8bPzndZxMDoHpxez5VOS+gC9Yi24/Q== + version "2.5.0" + resolved "https://registry.yarnpkg.com/bare-events/-/bare-events-2.5.0.tgz#305b511e262ffd8b9d5616b056464f8e1b3329cc" + integrity sha512-/E8dDe9dsbLyh2qrZ64PEPadOQ0F4gbl1sUJOrmph7xOiIxfY8vwab/4bFLh4Y88/Hk/ujKcrQKc+ps0mv873A== bare-fs@^2.1.1: - version "2.3.1" - resolved "https://registry.yarnpkg.com/bare-fs/-/bare-fs-2.3.1.tgz#cdbd63dac7a552dfb2b87d18c822298d1efd213d" - integrity sha512-W/Hfxc/6VehXlsgFtbB5B4xFcsCl+pAh30cYhoFyXErf6oGrwjh8SwiPAdHgpmWonKuYpZgGywN0SXt7dgsADA== + version "2.3.5" + resolved "https://registry.yarnpkg.com/bare-fs/-/bare-fs-2.3.5.tgz#05daa8e8206aeb46d13c2fe25a2cd3797b0d284a" + integrity sha512-SlE9eTxifPDJrT6YgemQ1WGFleevzwY+XAP1Xqgl56HtcrisC2CHCZ2tq6dBpcH2TnNxwUEUGhweo+lrQtYuiw== dependencies: bare-events "^2.0.0" bare-path "^2.0.0" bare-stream "^2.0.0" bare-os@^2.1.0: - version "2.4.0" - resolved "https://registry.yarnpkg.com/bare-os/-/bare-os-2.4.0.tgz#5de5e3ba7704f459c9656629edca7cc736e06608" - integrity sha512-v8DTT08AS/G0F9xrhyLtepoo9EJBJ85FRSMbu1pQUlAf6A8T0tEEQGMVObWeqpjhSPXsE0VGlluFBJu2fdoTNg== + version "2.4.4" + resolved "https://registry.yarnpkg.com/bare-os/-/bare-os-2.4.4.tgz#01243392eb0a6e947177bb7c8a45123d45c9b1a9" + integrity sha512-z3UiI2yi1mK0sXeRdc4O1Kk8aOa/e+FNWZcTiPB/dfTWyLypuE99LibgRaQki914Jq//yAWylcAt+mknKdixRQ== bare-path@^2.0.0, bare-path@^2.1.0: version "2.1.3" @@ -997,11 +984,12 @@ bare-path@^2.0.0, bare-path@^2.1.0: bare-os "^2.1.0" bare-stream@^2.0.0: - version "2.1.3" - resolved "https://registry.yarnpkg.com/bare-stream/-/bare-stream-2.1.3.tgz#070b69919963a437cc9e20554ede079ce0a129b2" - integrity sha512-tiDAH9H/kP+tvNO5sczyn9ZAA7utrSMobyDchsnyyXBuUe2FSQWbxhtuHB8jwpHYYevVo2UJpcmvvjrbHboUUQ== + version "2.3.0" + resolved "https://registry.yarnpkg.com/bare-stream/-/bare-stream-2.3.0.tgz#5bef1cab8222517315fca1385bd7f08dff57f435" + integrity sha512-pVRWciewGUeCyKEuRxwv06M079r+fRjAQjBEK2P6OYGrO43O+Z0LrPZZEjlc4mB6C2RpZ9AxJ1s7NLEtOHO6eA== dependencies: - streamx "^2.18.0" + b4a "^1.6.6" + streamx "^2.20.0" base64-js@^1.3.1: version "1.5.1" @@ -1046,17 +1034,17 @@ braces@^3.0.3: dependencies: fill-range "^7.1.1" -browserslist@^4.22.2: - version "4.23.1" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.23.1.tgz#ce4af0534b3d37db5c1a4ca98b9080f985041e96" - integrity sha512-TUfofFo/KsK/bWZ9TWQ5O26tsWW4Uhmt8IYklbnUa70udB6P2wA7w7o4PY4muaEPBQaAX+CEnmmIA41NVHtPVw== +browserslist@^4.24.0: + version "4.24.0" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.24.0.tgz#a1325fe4bc80b64fda169629fc01b3d6cecd38d4" + integrity sha512-Rmb62sR1Zpjql25eSanFGEhAxcFwfA1K0GuQcLoaJBAcENegrQut3hYdhXFF1obQfiDyqIW/cLM5HSJ/9k884A== dependencies: - caniuse-lite "^1.0.30001629" - electron-to-chromium "^1.4.796" - node-releases "^2.0.14" - update-browserslist-db "^1.0.16" + caniuse-lite "^1.0.30001663" + electron-to-chromium "^1.5.28" + node-releases "^2.0.18" + update-browserslist-db "^1.1.0" -bs-logger@0.x: +bs-logger@^0.2.6: version "0.2.6" resolved "https://registry.yarnpkg.com/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8" integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog== @@ -1070,10 +1058,10 @@ bser@2.1.1: dependencies: node-int64 "^0.4.0" -buffer-crc32@^0.2.1, buffer-crc32@^0.2.13: - version "0.2.13" - resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-0.2.13.tgz#0d333e3f00eac50aa1454abd30ef8c2a5d9a7242" - integrity sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ== +buffer-crc32@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-1.0.0.tgz#a10993b9055081d55304bd9feb4a072de179f405" + integrity sha512-Db1SbgBS/fg/392AblrMJk97KggmvYhr4pB5ZIMTWtaivCPMWLkmb7m21cJvpvgK+J3nsU2CmmixNBZx4vFj/w== buffer-from@^1.0.0: version "1.1.2" @@ -1088,6 +1076,14 @@ buffer@^5.5.0: base64-js "^1.3.1" ieee754 "^1.1.13" +buffer@^6.0.3: + version "6.0.3" + resolved "https://registry.yarnpkg.com/buffer/-/buffer-6.0.3.tgz#2ace578459cc8fbe2a70aaa8f52ee63b6a74c6c6" + integrity sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA== + dependencies: + base64-js "^1.3.1" + ieee754 "^1.2.1" + buildcheck@~0.0.6: version "0.0.6" resolved "https://registry.yarnpkg.com/buildcheck/-/buildcheck-0.0.6.tgz#89aa6e417cfd1e2196e3f8fe915eb709d2fe4238" @@ -1113,10 +1109,10 @@ camelcase@^6.2.0: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== -caniuse-lite@^1.0.30001629: - version "1.0.30001640" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001640.tgz#32c467d4bf1f1a0faa63fc793c2ba81169e7652f" - integrity sha512-lA4VMpW0PSUrFnkmVuEKBUovSWKhj7puyCg8StBChgu298N1AtuF1sKWEvfDuimSEDbhlb/KqPKC3fs1HbuQUA== +caniuse-lite@^1.0.30001663: + version "1.0.30001667" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001667.tgz#99fc5ea0d9c6e96897a104a8352604378377f949" + integrity sha512-7LTwJjcRkzKFmtqGsibMeuXmvFDfZq/nzIjnmgCGzKKRVzjD72selLDK1oPF/Oxzmt4fNcPvTDvGqSDG4tCALw== chalk@^2.4.2: version "2.4.2" @@ -1151,9 +1147,9 @@ ci-info@^3.2.0: integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== cjs-module-lexer@^1.0.0: - version "1.3.1" - resolved "https://registry.yarnpkg.com/cjs-module-lexer/-/cjs-module-lexer-1.3.1.tgz#c485341ae8fd999ca4ee5af2d7a1c9ae01e0099c" - integrity sha512-a3KdPAANPbNE4ZUv9h6LckSl9zLsYOP4MBmhIPkRaeyybt+r4UghLvq+xw/YwUcC1gqylCkL4rdVs3Lwupjm4Q== + version "1.4.1" + resolved "https://registry.yarnpkg.com/cjs-module-lexer/-/cjs-module-lexer-1.4.1.tgz#707413784dbb3a72aa11c2f2b042a0bef4004170" + integrity sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA== cliui@^8.0.1: version "8.0.1" @@ -1198,15 +1194,16 @@ color-name@~1.1.4: resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== -compress-commons@^4.1.2: - version "4.1.2" - resolved "https://registry.yarnpkg.com/compress-commons/-/compress-commons-4.1.2.tgz#6542e59cb63e1f46a8b21b0e06f9a32e4c8b06df" - integrity sha512-D3uMHtGc/fcO1Gt1/L7i1e33VOvD4A9hfQLP+6ewd+BvG/gQ84Yh4oftEhAdjSMgBgwGL+jsppT7JYNpo6MHHg== +compress-commons@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/compress-commons/-/compress-commons-6.0.2.tgz#26d31251a66b9d6ba23a84064ecd3a6a71d2609e" + integrity sha512-6FqVXeETqWPoGcfzrXb37E50NP0LXT8kAMu5ooZayhWWdgEY4lBEEcbQNXtkuKQsGduxiIcI4gOTsxTmuq/bSg== dependencies: - buffer-crc32 "^0.2.13" - crc32-stream "^4.0.2" + crc-32 "^1.2.0" + crc32-stream "^6.0.0" + is-stream "^2.0.1" normalize-path "^3.0.0" - readable-stream "^3.6.0" + readable-stream "^4.0.0" concat-map@0.0.1: version "0.0.1" @@ -1223,7 +1220,7 @@ core-util-is@~1.0.0: resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== -cpu-features@~0.0.9: +cpu-features@~0.0.10: version "0.0.10" resolved "https://registry.yarnpkg.com/cpu-features/-/cpu-features-0.0.10.tgz#9aae536db2710c7254d7ed67cb3cbc7d29ad79c5" integrity sha512-9IkYqtX3YHPCzoVg1Py+o9057a3i0fp7S530UWokCSaFVTc7CwXPRiOjRjBQQ18ZCNafx78YfnG+HALxtVmOGA== @@ -1236,13 +1233,13 @@ crc-32@^1.2.0: resolved "https://registry.yarnpkg.com/crc-32/-/crc-32-1.2.2.tgz#3cad35a934b8bf71f25ca524b6da51fb7eace2ff" integrity sha512-ROmzCKrTnOwybPcJApAA6WBWij23HVfGVNKqqrZpuyZOHqK2CwHSvpGuyt/UNNvaIjEd8X5IFGp4Mh+Ie1IHJQ== -crc32-stream@^4.0.2: - version "4.0.3" - resolved "https://registry.yarnpkg.com/crc32-stream/-/crc32-stream-4.0.3.tgz#85dd677eb78fa7cad1ba17cc506a597d41fc6f33" - integrity sha512-NT7w2JVU7DFroFdYkeq8cywxrgjPHWkdX1wjpRQXPX5Asews3tA+Ght6lddQO5Mkumffp3X7GEqku3epj2toIw== +crc32-stream@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/crc32-stream/-/crc32-stream-6.0.0.tgz#8529a3868f8b27abb915f6c3617c0fadedbf9430" + integrity sha512-piICUB6ei4IlTv1+653yq5+KoqfBYmj9bw6LqXoOneTMDXk5nM1qt12mFW1caG3LlJXEKW1Bp0WggEmIfQB34g== dependencies: crc-32 "^1.2.0" - readable-stream "^3.4.0" + readable-stream "^4.0.0" create-jest@^29.7.0: version "29.7.0" @@ -1279,12 +1276,17 @@ cwd@^0.10.0: find-pkg "^0.1.2" fs-exists-sync "^0.1.0" -debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.4: - version "4.3.5" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.5.tgz#e83444eceb9fedd4a1da56d671ae2446a01a6e1e" - integrity sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg== +data-uri-to-buffer@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz#d8feb2b2881e6a4f58c2e08acfd0e2834e26222e" + integrity sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A== + +debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.5: + version "4.3.7" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.7.tgz#87945b4151a011d76d95a198d7111c865c360a52" + integrity sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ== dependencies: - ms "2.1.2" + ms "^2.1.3" dedent@^1.0.0: version "1.5.3" @@ -1311,7 +1313,7 @@ diff@^4.0.1: resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d" integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A== -docker-compose@^0.24.6: +docker-compose@^0.24.8: version "0.24.8" resolved "https://registry.yarnpkg.com/docker-compose/-/docker-compose-0.24.8.tgz#6c125e6b9e04cf68ced47e2596ef2bb93ee9694e" integrity sha512-plizRs/Vf15H+GCVxq2EUvyPK7ei9b/cVesHvjnX4xaXjM9spHe2Ytq0BitndFgvTJ3E3NljPNUEl7BAN43iZw== @@ -1347,17 +1349,17 @@ eastasianwidth@^0.2.0: resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== -ejs@^3.0.0: +ejs@^3.1.10: version "3.1.10" resolved "https://registry.yarnpkg.com/ejs/-/ejs-3.1.10.tgz#69ab8358b14e896f80cc39e62087b88500c3ac3b" integrity sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA== dependencies: jake "^10.8.5" -electron-to-chromium@^1.4.796: - version "1.4.818" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.818.tgz#7762c8bfd15a07c3833b7f5deed990e9e5a4c24f" - integrity sha512-eGvIk2V0dGImV9gWLq8fDfTTsCAeMDwZqEPMr+jMInxZdnp9Us8UpovYpRCf9NQ7VOFgrN2doNSgvISbsbNpxA== +electron-to-chromium@^1.5.28: + version "1.5.33" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.33.tgz#8f64698661240e70fdbc4b032e6085e391f05e09" + integrity sha512-+cYTcFB1QqD4j4LegwLfpCNxifb6dDFUAwk6RsLusCwIaZI6or2f+q8rs5tTB2YC53HhOlIbEaqHMAAC8IOIwA== emittery@^0.13.1: version "0.13.1" @@ -1388,10 +1390,10 @@ error-ex@^1.3.1: dependencies: is-arrayish "^0.2.1" -escalade@^3.1.1, escalade@^3.1.2: - version "3.1.2" - resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.2.tgz#54076e9ab29ea5bf3d8f1ed62acffbb88272df27" - integrity sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA== +escalade@^3.1.1, escalade@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5" + integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA== escape-string-regexp@^1.0.5: version "1.0.5" @@ -1408,6 +1410,16 @@ esprima@^4.0.0: resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== +event-target-shim@^5.0.0: + version "5.0.1" + resolved "https://registry.yarnpkg.com/event-target-shim/-/event-target-shim-5.0.1.tgz#5d4d3ebdf9583d63a5333ce2deb7480ab2b05789" + integrity sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ== + +events@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" + integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== + execa@^5.0.0: version "5.1.1" resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" @@ -1463,6 +1475,14 @@ fb-watchman@^2.0.0: dependencies: bser "2.1.1" +fetch-blob@^3.1.2, fetch-blob@^3.1.4: + version "3.2.0" + resolved "https://registry.yarnpkg.com/fetch-blob/-/fetch-blob-3.2.0.tgz#f09b8d4bbd45adc6f0c20b7e787e793e309dcce9" + integrity sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ== + dependencies: + node-domexception "^1.0.0" + web-streams-polyfill "^3.0.3" + filelist@^1.0.4: version "1.0.4" resolved "https://registry.yarnpkg.com/filelist/-/filelist-1.0.4.tgz#f78978a1e944775ff9e62e744424f215e58352b5" @@ -1501,13 +1521,20 @@ find-up@^4.0.0, find-up@^4.1.0: path-exists "^4.0.0" foreground-child@^3.1.0: - version "3.2.1" - resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.2.1.tgz#767004ccf3a5b30df39bed90718bab43fe0a59f7" - integrity sha512-PXUUyLqrR2XCWICfv6ukppP96sdFwWbNEnfEMt7jNsISjMsvaLNinAHNDYyvkyU+SZG2BTSbT5NjG+vZslfGTA== + version "3.3.0" + resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.3.0.tgz#0ac8644c06e431439f8561db8ecf29a7b5519c77" + integrity sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg== dependencies: cross-spawn "^7.0.0" signal-exit "^4.0.1" +formdata-polyfill@^4.0.10: + version "4.0.10" + resolved "https://registry.yarnpkg.com/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz#24807c31c9d402e002ab3d8c720144ceb8848423" + integrity sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g== + dependencies: + fetch-blob "^3.1.2" + fs-constants@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/fs-constants/-/fs-constants-1.0.0.tgz#6be0de9be998ce16af8afc24497b9ee9b7ccd9ad" @@ -1558,10 +1585,10 @@ get-stream@^6.0.0: resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== -glob@^10.3.7: - version "10.4.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-10.4.3.tgz#e0ba2253dd21b3d0acdfb5d507c59a29f513fc7a" - integrity sha512-Q38SGlYRpVtDBPSWEylRyctn7uDeTp4NQERTLiCT1FqA9JXPYWqAVmQU6qh4r/zMM5ehxTcbaO8EjhWnvEhmyg== +glob@^10.0.0, glob@^10.3.7: + version "10.4.5" + resolved "https://registry.yarnpkg.com/glob/-/glob-10.4.5.tgz#f4d9f0b90ffdbab09c9d77f5f29b4262517b0956" + integrity sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg== dependencies: foreground-child "^3.1.0" jackspeak "^3.1.2" @@ -1570,7 +1597,7 @@ glob@^10.3.7: package-json-from-dist "^1.0.0" path-scurry "^1.11.1" -glob@^7.1.3, glob@^7.1.4, glob@^7.2.3: +glob@^7.1.3, glob@^7.1.4: version "7.2.3" resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== @@ -1644,15 +1671,15 @@ human-signals@^2.1.0: resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== -ieee754@^1.1.13: +ieee754@^1.1.13, ieee754@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.2.1.tgz#8eb7a10a63fff25d15a57b001586d177d1b0d352" integrity sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA== import-local@^3.0.2: - version "3.1.0" - resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.1.0.tgz#b4479df8a5fd44f6cdce24070675676063c95cb4" - integrity sha512-ASB07uLtnDs1o6EHjKpX34BKYDSqnFerfTOJL2HvMqF70LnxpjkzDB8J44oT9pu4AMPkQwf8jl6szgvNd2tRIg== + version "3.2.0" + resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.2.0.tgz#c3d5c745798c02a6f8b897726aba5100186ee260" + integrity sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA== dependencies: pkg-dir "^4.2.0" resolve-cwd "^3.0.0" @@ -1686,9 +1713,9 @@ is-arrayish@^0.2.1: integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== is-core-module@^2.13.0: - version "2.14.0" - resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.14.0.tgz#43b8ef9f46a6a08888db67b1ffd4ec9e3dfd59d1" - integrity sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A== + version "2.15.1" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.15.1.tgz#a7363a25bee942fefab0de13bf6aa372c82dcc37" + integrity sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ== dependencies: hasown "^2.0.2" @@ -1707,7 +1734,7 @@ is-number@^7.0.0: resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== -is-stream@^2.0.0: +is-stream@^2.0.0, is-stream@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== @@ -1781,18 +1808,18 @@ istanbul-reports@^3.1.3: istanbul-lib-report "^3.0.0" jackspeak@^3.1.2: - version "3.4.1" - resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-3.4.1.tgz#145422416740568e9fc357bf60c844b3c1585f09" - integrity sha512-U23pQPDnmYybVkYjObcuYMk43VRlMLLqLI+RdZy8s8WV8WsxO9SnqSroKaluuvcNOdCAlauKszDwd+umbot5Mg== + version "3.4.3" + resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-3.4.3.tgz#8833a9d89ab4acde6188942bd1c53b6390ed5a8a" + integrity sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw== dependencies: "@isaacs/cliui" "^8.0.2" optionalDependencies: "@pkgjs/parseargs" "^0.11.0" jake@^10.8.5: - version "10.9.1" - resolved "https://registry.yarnpkg.com/jake/-/jake-10.9.1.tgz#8dc96b7fcc41cb19aa502af506da4e1d56f5e62b" - integrity sha512-61btcOHNnLnsOdtLgA5efqQWjnSi/vow5HbI7HMdKKWqvrKR1bLK3BPlJn9gcSaP2ewuamUSMB5XEy76KUIS2w== + version "10.9.2" + resolved "https://registry.yarnpkg.com/jake/-/jake-10.9.2.tgz#6ae487e6a69afec3a5e167628996b59f35ae2b7f" + integrity sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA== dependencies: async "^3.2.3" chalk "^4.0.2" @@ -2170,10 +2197,10 @@ js-yaml@^3.13.1: argparse "^1.0.7" esprima "^4.0.0" -jsesc@^2.5.1: - version "2.5.2" - resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4" - integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA== +jsesc@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.0.2.tgz#bb8b09a6597ba426425f2e4a07245c3d00b9343e" + integrity sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g== json-parse-even-better-errors@^2.3.0: version "2.3.1" @@ -2214,40 +2241,20 @@ locate-path@^5.0.0: dependencies: p-locate "^4.1.0" -lodash.defaults@^4.2.0: - version "4.2.0" - resolved "https://registry.yarnpkg.com/lodash.defaults/-/lodash.defaults-4.2.0.tgz#d09178716ffea4dde9e5fb7b37f6f0802274580c" - integrity sha512-qjxPLHd3r5DnsdGacqOMU6pb/avJzdh9tFX2ymgoZE27BmjXrNy/y4LoaiTeAb+O3gL8AfpJGtqfX/ae2leYYQ== - -lodash.difference@^4.5.0: - version "4.5.0" - resolved "https://registry.yarnpkg.com/lodash.difference/-/lodash.difference-4.5.0.tgz#9ccb4e505d486b91651345772885a2df27fd017c" - integrity sha512-dS2j+W26TQ7taQBGN8Lbbq04ssV3emRw4NY58WErlTO29pIqS0HmoT5aJ9+TUQ1N3G+JOZSji4eugsWwGp9yPA== - -lodash.flatten@^4.4.0: - version "4.4.0" - resolved "https://registry.yarnpkg.com/lodash.flatten/-/lodash.flatten-4.4.0.tgz#f31c22225a9632d2bbf8e4addbef240aa765a61f" - integrity sha512-C5N2Z3DgnnKr0LOpv/hKCgKdb7ZZwafIrsesve6lmzvZIRZRGaZ/l6Q8+2W7NaT+ZwO3fFlSCzCzrDCFdJfZ4g== - -lodash.isplainobject@^4.0.6: - version "4.0.6" - resolved "https://registry.yarnpkg.com/lodash.isplainobject/-/lodash.isplainobject-4.0.6.tgz#7c526a52d89b45c45cc690b88163be0497f550cb" - integrity sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA== - -lodash.memoize@4.x: +lodash.memoize@^4.1.2: version "4.1.2" resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag== -lodash.union@^4.6.0: - version "4.6.0" - resolved "https://registry.yarnpkg.com/lodash.union/-/lodash.union-4.6.0.tgz#48bb5088409f16f1821666641c44dd1aaae3cd88" - integrity sha512-c4pB2CdGrGdjMKYLA+XiRDO7Y0PRQbm/Gzg8qMj+QH+pFVAoTp5sBpO0odL3FjoPCGjK96p6qsP+yQoiLoOBcw== +lodash@^4.17.15: + version "4.17.21" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" + integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== lru-cache@^10.2.0: - version "10.4.0" - resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.0.tgz#cb29b4b2dd55b22e4a729cdb096093d7f85df02d" - integrity sha512-bfJaPTuEiTYBu+ulDaeQ0F+uLmlfFkMgXj4cbwfuMSjgObGMzb55FMMbDvbRU0fAHZ4sLGkz2mKwcMg8Dvm8Ww== + version "10.4.3" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119" + integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ== lru-cache@^5.1.1: version "5.1.1" @@ -2263,7 +2270,7 @@ make-dir@^4.0.0: dependencies: semver "^7.5.3" -make-error@1.x, make-error@^1.1.1: +make-error@^1.1.1, make-error@^1.3.6: version "1.3.6" resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2" integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw== @@ -2281,9 +2288,9 @@ merge-stream@^2.0.0: integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== micromatch@^4.0.4: - version "4.0.7" - resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.7.tgz#33e8190d9fe474a9895525f5618eee136d46c2e5" - integrity sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q== + version "4.0.8" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" + integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== dependencies: braces "^3.0.3" picomatch "^2.3.1" @@ -2329,12 +2336,12 @@ mkdirp@^1.0.4: resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e" integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== -ms@2.1.2: - version "2.1.2" - resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" - integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== +ms@^2.1.3: + version "2.1.3" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== -nan@^2.18.0, nan@^2.19.0: +nan@^2.19.0, nan@^2.20.0: version "2.20.0" resolved "https://registry.yarnpkg.com/nan/-/nan-2.20.0.tgz#08c5ea813dd54ed16e5bd6505bf42af4f7838ca3" integrity sha512-bk3gXBZDGILuuo/6sKtr0DQmSThYHLtNCdSdXk9YkxD/jK6X2vmCyyXBBxyqZ4XcnzTyYEAThfX3DCEnLf6igw== @@ -2344,22 +2351,29 @@ natural-compare@^1.4.0: resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" integrity sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw== -node-fetch@^2.6.13, node-fetch@^2.7.0: - version "2.7.0" - resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d" - integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A== +node-domexception@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/node-domexception/-/node-domexception-1.0.0.tgz#6888db46a1f71c0b76b3f7555016b63fe64766e5" + integrity sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ== + +node-fetch@^3.3.2: + version "3.3.2" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-3.3.2.tgz#d1e889bacdf733b4ff3b2b243eb7a12866a0b78b" + integrity sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA== dependencies: - whatwg-url "^5.0.0" + data-uri-to-buffer "^4.0.0" + fetch-blob "^3.1.4" + formdata-polyfill "^4.0.10" node-int64@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" integrity sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw== -node-releases@^2.0.14: - version "2.0.14" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.14.tgz#2ffb053bceb8b2be8495ece1ab6ce600c4461b0b" - integrity sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw== +node-releases@^2.0.18: + version "2.0.18" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.18.tgz#f010e8d35e2fe8d6b2944f03f70213ecedc4ca3f" + integrity sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g== normalize-path@^3.0.0: version "3.0.0" @@ -2419,9 +2433,9 @@ p-try@^2.0.0: integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== package-json-from-dist@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz#e501cd3094b278495eb4258d4c9f6d5ac3019f00" - integrity sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw== + version "1.0.1" + resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz#4f1471a010827a86f94cfd9b0727e36d267de505" + integrity sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw== parse-json@^5.2.0: version "5.2.0" @@ -2466,10 +2480,10 @@ path-scurry@^1.11.1: lru-cache "^10.2.0" minipass "^5.0.0 || ^6.0.2 || ^7.0.0" -picocolors@^1.0.0, picocolors@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.0.1.tgz#a8ad579b571952f0e5d25892de5445bcfe25aaa1" - integrity sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew== +picocolors@^1.0.0, picocolors@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.0.tgz#5358b76a78cde483ba5cef6a9dc9671440b27d59" + integrity sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw== picomatch@^2.0.4, picomatch@^2.2.3, picomatch@^2.3.1: version "2.3.1" @@ -2488,6 +2502,11 @@ pkg-dir@^4.2.0: dependencies: find-up "^4.0.0" +prettier@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105" + integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew== + pretty-format@^29.0.0, pretty-format@^29.7.0: version "29.7.0" resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-29.7.0.tgz#ca42c758310f365bfa71a0bda0a807160b776812" @@ -2502,6 +2521,11 @@ process-nextick-args@~2.0.0: resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== +process@^0.11.10: + version "0.11.10" + resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182" + integrity sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A== + prompts@^2.0.1: version "2.4.2" resolved "https://registry.yarnpkg.com/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" @@ -2527,9 +2551,9 @@ properties-reader@^2.3.0: mkdirp "^1.0.4" pump@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64" - integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== + version "3.0.2" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.2.tgz#836f3edd6bc2ee599256c924ffe0d88573ddcbf8" + integrity sha512-tUPXtzlGM8FE3P0ZL6DVs/3P58k9nk8/jZeQCurTJylQA8qFYzHFfhBJkuqyE0FifOsQ0uKWekiZ5g8wtr28cw== dependencies: end-of-stream "^1.1.0" once "^1.3.1" @@ -2549,7 +2573,7 @@ react-is@^18.0.0: resolved "https://registry.yarnpkg.com/react-is/-/react-is-18.3.1.tgz#e83557dc12eae63a99e003a46388b1dcbb44db7e" integrity sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg== -readable-stream@^2.0.0, readable-stream@^2.0.5: +readable-stream@^2.0.5: version "2.3.8" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.8.tgz#91125e8042bba1b9887f49345f6277027ce8be9b" integrity sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA== @@ -2562,7 +2586,7 @@ readable-stream@^2.0.0, readable-stream@^2.0.5: string_decoder "~1.1.1" util-deprecate "~1.0.1" -readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.5.0, readable-stream@^3.6.0: +readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.5.0: version "3.6.2" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== @@ -2571,6 +2595,17 @@ readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.5.0, readable string_decoder "^1.1.1" util-deprecate "^1.0.1" +readable-stream@^4.0.0: + version "4.5.2" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-4.5.2.tgz#9e7fc4c45099baeed934bff6eb97ba6cf2729e09" + integrity sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g== + dependencies: + abort-controller "^3.0.0" + buffer "^6.0.3" + events "^3.3.0" + process "^0.11.10" + string_decoder "^1.3.0" + readdir-glob@^1.1.2: version "1.1.3" resolved "https://registry.yarnpkg.com/readdir-glob/-/readdir-glob-1.1.3.tgz#c3d831f51f5e7bfa62fa2ffbe4b508c640f09584" @@ -2623,9 +2658,9 @@ retry@^0.12.0: integrity sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow== rimraf@^5.0.8: - version "5.0.8" - resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-5.0.8.tgz#9d4d0ef5106817102b14fdbbf01cf29545e99a6c" - integrity sha512-XSh0V2/yNhDEi8HwdIefD8MLgs4LQXPag/nEJWs3YUc3Upn+UHa1GyIkEg9xSSNt7HnkO5FjTvmcRzgf+8UZuw== + version "5.0.10" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-5.0.10.tgz#23b9843d3dc92db71f96e1a2ce92e39fd2a8221c" + integrity sha512-l0OE8wL34P4nJH/H2ffoaniAokM2qSmrtXHmlpvYr5AVVX8msAyW0l8NVJFDxlSK4u3Uh/f41cQheDVdnYijwQ== dependencies: glob "^10.3.7" @@ -2649,10 +2684,10 @@ semver@^6.3.0, semver@^6.3.1: resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== -semver@^7.5.3, semver@^7.5.4: - version "7.6.2" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.2.tgz#1e3b34759f896e8f14d6134732ce798aeb0c6e13" - integrity sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w== +semver@^7.5.3, semver@^7.5.4, semver@^7.6.3: + version "7.6.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.3.tgz#980f7b5550bc175fb4dc09403085627f9eb33143" + integrity sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A== shebang-command@^2.0.0: version "2.0.0" @@ -2718,15 +2753,15 @@ ssh-remote-port-forward@^1.0.4: ssh2 "^1.4.0" ssh2@^1.11.0, ssh2@^1.4.0: - version "1.15.0" - resolved "https://registry.yarnpkg.com/ssh2/-/ssh2-1.15.0.tgz#2f998455036a7f89e0df5847efb5421748d9871b" - integrity sha512-C0PHgX4h6lBxYx7hcXwu3QWdh4tg6tZZsTfXcdvc5caW/EMxaB4H9dWsl7qk+F7LAW762hp8VbXOX7x4xUYvEw== + version "1.16.0" + resolved "https://registry.yarnpkg.com/ssh2/-/ssh2-1.16.0.tgz#79221d40cbf4d03d07fe881149de0a9de928c9f0" + integrity sha512-r1X4KsBGedJqo7h8F5c4Ybpcr5RjyP+aWIG007uBPRjmdQWfEiVLzSK71Zji1B9sKxwaCvD8y8cwSkYrlLiRRg== dependencies: asn1 "^0.2.6" bcrypt-pbkdf "^1.0.2" optionalDependencies: - cpu-features "~0.0.9" - nan "^2.18.0" + cpu-features "~0.0.10" + nan "^2.20.0" stack-utils@^2.0.3: version "2.0.6" @@ -2735,10 +2770,10 @@ stack-utils@^2.0.3: dependencies: escape-string-regexp "^2.0.0" -streamx@^2.15.0, streamx@^2.18.0: - version "2.18.0" - resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.18.0.tgz#5bc1a51eb412a667ebfdcd4e6cf6a6fc65721ac7" - integrity sha512-LLUC1TWdjVdn1weXGcSxyTR3T4+acB6tVGXT95y0nGbca4t4o/ng1wKAGTljm9VicuCVLvRlqFYXYy5GwgM7sQ== +streamx@^2.15.0, streamx@^2.20.0: + version "2.20.1" + resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.20.1.tgz#471c4f8b860f7b696feb83d5b125caab2fdbb93c" + integrity sha512-uTa0mU6WUC65iUvzKH4X9hEdvSW7rbPxPtwfWiLMSj3qTdQbAiUboZTxauKfpFuGIGa1C2BYijZ7wgdUXICJhA== dependencies: fast-fifo "^1.3.2" queue-tick "^1.0.1" @@ -2781,7 +2816,7 @@ string-width@^5.0.1, string-width@^5.1.2: emoji-regex "^9.2.2" strip-ansi "^7.0.1" -string_decoder@^1.1.1: +string_decoder@^1.1.1, string_decoder@^1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== @@ -2857,7 +2892,7 @@ supports-preserve-symlinks-flag@^1.0.0: resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== -tar-fs@^3.0.5: +tar-fs@^3.0.6: version "3.0.6" resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-3.0.6.tgz#eaccd3a67d5672f09ca8e8f9c3d2b89fa173f217" integrity sha512-iokBDQQkUyeXhgPYaZxmczGPhnhXZ0CmrqI+MOb/WFGS9DW5wnfrLgtjUJBvz50vQ3qfRwJ62QVoCFu8mPVu5w== @@ -2878,7 +2913,7 @@ tar-fs@~2.0.1: pump "^3.0.0" tar-stream "^2.0.0" -tar-stream@^2.0.0, tar-stream@^2.2.0: +tar-stream@^2.0.0: version "2.2.0" resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-2.2.0.tgz#acad84c284136b060dc3faa64474aa9aebd77287" integrity sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ== @@ -2889,7 +2924,7 @@ tar-stream@^2.0.0, tar-stream@^2.2.0: inherits "^2.0.3" readable-stream "^3.1.1" -tar-stream@^3.1.5: +tar-stream@^3.0.0, tar-stream@^3.1.5: version "3.1.7" resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-3.1.7.tgz#24b3fb5eabada19fe7338ed6d26e5f7c482e792b" integrity sha512-qJj60CXt7IU1Ffyc3NJMjh6EkuCFej46zUqJ4J7pqYlThyd9bO0XBTmcOIhSzZJVWfsLks0+nle/j538YAW9RQ== @@ -2907,35 +2942,35 @@ test-exclude@^6.0.0: glob "^7.1.4" minimatch "^3.0.4" -testcontainers@10.9.0: - version "10.9.0" - resolved "https://registry.yarnpkg.com/testcontainers/-/testcontainers-10.9.0.tgz#9d5b2ef189ed32a0be376d013017ba8593a09e93" - integrity sha512-LN+cKAOd61Up9SVMJW+3VFVGeVQG8JBqZhEQo2U0HBfIsAynyAXcsLBSo+KZrOfy9SBz7pGHctWN/KabLDbNFA== +testcontainers@10.13.1: + version "10.13.1" + resolved "https://registry.yarnpkg.com/testcontainers/-/testcontainers-10.13.1.tgz#febdf275cd3156bee76428908fdeeb7dd53a0b5f" + integrity sha512-JBbOhxmygj/ouH/47GnoVNt+c55Telh/45IjVxEbDoswsLchVmJiuKiw/eF6lE5i7LN+/99xsrSCttI3YRtirg== dependencies: "@balena/dockerignore" "^1.0.2" - "@types/dockerode" "^3.3.24" - archiver "^5.3.2" + "@types/dockerode" "^3.3.29" + archiver "^7.0.1" async-lock "^1.4.1" byline "^5.0.0" - debug "^4.3.4" - docker-compose "^0.24.6" + debug "^4.3.5" + docker-compose "^0.24.8" dockerode "^3.3.5" get-port "^5.1.1" - node-fetch "^2.7.0" proper-lockfile "^4.1.2" properties-reader "^2.3.0" ssh-remote-port-forward "^1.0.4" - tar-fs "^3.0.5" - tmp "^0.2.1" + tar-fs "^3.0.6" + tmp "^0.2.3" + undici "^5.28.4" text-decoder@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/text-decoder/-/text-decoder-1.1.0.tgz#3379e728fcf4d3893ec1aea35e8c2cac215ef190" - integrity sha512-TmLJNj6UgX8xcUZo4UDStGQtDiTzF7BzWlzn9g7UWrjkpHr5uJTK1ld16wZ3LXb2vb6jH8qU89dW5whuMdXYdw== + version "1.2.0" + resolved "https://registry.yarnpkg.com/text-decoder/-/text-decoder-1.2.0.tgz#85f19d4d5088e0b45cd841bdfaeac458dbffeefc" + integrity sha512-n1yg1mOj9DNpk3NeZOx7T6jchTbyJS3i3cucbNN6FcdPriMZx7NsgrGpWWdWZZGxD7ES1XB+3uoqHMgOKaN+fg== dependencies: b4a "^1.6.4" -tmp@^0.2.1: +tmp@^0.2.3: version "0.2.3" resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.2.3.tgz#eb783cc22bc1e8bebd0671476d46ea4eb32a79ae" integrity sha512-nZD7m9iCPC5g0pYmcaxogYKggSfLsdxl8of3Q/oIbqCqLLIO9IAF0GWjX1z9NZRHPiXv8Wex4yDCaZsgEw0Y8w== @@ -2957,25 +2992,20 @@ to-regex-range@^5.0.1: dependencies: is-number "^7.0.0" -tr46@~0.0.3: - version "0.0.3" - resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" - integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw== - -ts-jest@^29.2.2: - version "29.2.2" - resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.2.2.tgz#0d2387bb04d39174b20a05172a968f258aedff4d" - integrity sha512-sSW7OooaKT34AAngP6k1VS669a0HdLxkQZnlC7T76sckGCokXFnvJ3yRlQZGRTAoV5K19HfSgCiSwWOSIfcYlg== +ts-jest@29.2.5: + version "29.2.5" + resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.2.5.tgz#591a3c108e1f5ebd013d3152142cb5472b399d63" + integrity sha512-KD8zB2aAZrcKIdGk4OwpJggeLcH1FgrICqDSROWqlnJXGCXK4Mn6FcdK2B6670Xr73lHMG1kHw8R87A0ecZ+vA== dependencies: - bs-logger "0.x" - ejs "^3.0.0" - fast-json-stable-stringify "2.x" + bs-logger "^0.2.6" + ejs "^3.1.10" + fast-json-stable-stringify "^2.1.0" jest-util "^29.0.0" json5 "^2.2.3" - lodash.memoize "4.x" - make-error "1.x" - semver "^7.5.3" - yargs-parser "^21.0.1" + lodash.memoize "^4.1.2" + make-error "^1.3.6" + semver "^7.6.3" + yargs-parser "^21.1.1" ts-node@^10.9.2: version "10.9.2" @@ -3011,23 +3041,35 @@ type-fest@^0.21.3: resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== -typescript@^5.5.3: - version "5.5.3" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.5.3.tgz#e1b0a3c394190838a0b168e771b0ad56a0af0faa" - integrity sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ== +typescript@5.5.4: + version "5.5.4" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.5.4.tgz#d9852d6c82bad2d2eda4fd74a5762a8f5909e9ba" + integrity sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q== undici-types@~5.26.4: version "5.26.5" resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617" integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA== -update-browserslist-db@^1.0.16: - version "1.1.0" - resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz#7ca61c0d8650766090728046e416a8cde682859e" - integrity sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ== +undici-types@~6.19.2: + version "6.19.8" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02" + integrity sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw== + +undici@^5.28.4: + version "5.28.4" + resolved "https://registry.yarnpkg.com/undici/-/undici-5.28.4.tgz#6b280408edb6a1a604a9b20340f45b422e373068" + integrity sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g== + dependencies: + "@fastify/busboy" "^2.0.0" + +update-browserslist-db@^1.1.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz#80846fba1d79e82547fb661f8d141e0945755fe5" + integrity sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A== dependencies: - escalade "^3.1.2" - picocolors "^1.0.1" + escalade "^3.2.0" + picocolors "^1.1.0" util-deprecate@^1.0.1, util-deprecate@~1.0.1: version "1.0.2" @@ -3055,18 +3097,10 @@ walker@^1.0.8: dependencies: makeerror "1.0.12" -webidl-conversions@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871" - integrity sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ== - -whatwg-url@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d" - integrity sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw== - dependencies: - tr46 "~0.0.3" - webidl-conversions "^3.0.0" +web-streams-polyfill@^3.0.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz#2073b91a2fdb1fbfbd401e7de0ac9f8214cecb4b" + integrity sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw== which@^1.2.12: version "1.3.1" @@ -3133,11 +3167,11 @@ yallist@^3.0.2: integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== yaml@^2.2.2: - version "2.4.5" - resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.4.5.tgz#60630b206dd6d84df97003d33fc1ddf6296cca5e" - integrity sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg== + version "2.5.1" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.5.1.tgz#c9772aacf62cb7494a95b0c4f1fb065b563db130" + integrity sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q== -yargs-parser@^21.0.1, yargs-parser@^21.1.1: +yargs-parser@^21.1.1: version "21.1.1" resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35" integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== @@ -3165,11 +3199,11 @@ yocto-queue@^0.1.0: resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== -zip-stream@^4.1.0: - version "4.1.1" - resolved "https://registry.yarnpkg.com/zip-stream/-/zip-stream-4.1.1.tgz#1337fe974dbaffd2fa9a1ba09662a66932bd7135" - integrity sha512-9qv4rlDiopXg4E69k+vMHjNN63YFMe9sZMrdlvKnCjlCRWeCBswPPMPUfx+ipsAWq1LXHe70RcbaHdJJpS6hyQ== +zip-stream@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/zip-stream/-/zip-stream-6.0.1.tgz#e141b930ed60ccaf5d7fa9c8260e0d1748a2bbfb" + integrity sha512-zK7YHHz4ZXpW89AHXUPbQVGKI7uvkd3hzusTdotCg1UxyaVtg0zFJSTfW/Dq5f7OBBVnq6cZIaC8Ti4hb6dtCA== dependencies: - archiver-utils "^3.0.4" - compress-commons "^4.1.2" - readable-stream "^3.6.0" + archiver-utils "^5.0.0" + compress-commons "^6.0.2" + readable-stream "^4.0.0" From 262532f419a2dd30725e46b459dee3ef89b90067 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Wed, 9 Oct 2024 09:17:38 +1000 Subject: [PATCH 2/9] Remove playbook commited accidentially --- ansible/helloworld_playbook.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 ansible/helloworld_playbook.yml diff --git a/ansible/helloworld_playbook.yml b/ansible/helloworld_playbook.yml deleted file mode 100644 index e69de29..0000000 From 99a5a21e5172365d97e1197021ae518dde80527a Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Wed, 9 Oct 2024 14:00:34 +1000 Subject: [PATCH 3/9] Updated command logic on package.json --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ba383a2..17f6ee2 100644 --- a/package.json +++ b/package.json @@ -16,10 +16,10 @@ "awx:build": "(git -C awx pull || git clone -b devel https://github.com/ansible/awx.git awx) && (cd awx && make docker-compose-build && make clean/ui ui)", "awx:start": "(cd awx && make docker-compose)", "awx:superuser": "docker exec -ti tools_awx_1 awx-manage createsuperuser", - "clean": "rimraf awx && rimraf dist && rimraf generated && rimraf yarn-error.log && rimraf node_modules && rimraf typescript-fetch-client", + "clean": "rimraf awx && rimraf dist && rimraf generated && rimraf yarn-error.log && rimraf typescript-fetch-client && rimraf node_modules", "regen": "(cd awx && make docker-compose)", "prebuild": "node ./generate.js", - "build": "(cd ./typescript-fetch-client && yarn install && yarn build)", + "build": "node ./generate.js && (cd ./typescript-fetch-client && yarn install && yarn build)", "test": "tsc && jest" }, "dependencies": { From a370a7c3d187f4b896c24edbe2754c4729a52b47 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Thu, 10 Oct 2024 13:50:11 +1000 Subject: [PATCH 4/9] Move configuration into it's own folder --- test/ApiApi.test.ts | 39 ++++++++++++++++++--------------------- test/Config.ts | 8 ++++++++ 2 files changed, 26 insertions(+), 21 deletions(-) create mode 100644 test/Config.ts diff --git a/test/ApiApi.test.ts b/test/ApiApi.test.ts index 53a61b0..c042eb2 100644 --- a/test/ApiApi.test.ts +++ b/test/ApiApi.test.ts @@ -1,24 +1,21 @@ -import {ApiApi, Configuration, FetchAPI} from 'awx-api-client'; +import { ApiApi } from "awx-api-client"; +import { configuration } from "./Config"; +describe("AWXApiTest", () => { + const api = new ApiApi(configuration); -describe("AWX API Test", () => { - const basePath = `http://${global.__TESTCONTAINERS_AWX_IP__}:${global.__TESTCONTAINERS_AWX_PORT_8080__}`; - const configuration = new Configuration({ - basePath, - fetchApi: fetch as unknown as FetchAPI + test("api list", async () => { + const response = await api.apiList(); + console.log(response); + expect(response).toEqual({ + description: "AWX REST API", + current_version: "/api/v2/", + available_versions: { v2: "/api/v2/" }, + oauth2: "/api/o/", + custom_logo: "", + custom_login_info: "", + login_redirect_override: "", + swagger: "/api/swagger/", }); - const api = new ApiApi(configuration); - test("api list", async () => { - const response = await api.apiList(); - expect(response).toEqual({ - "description": "AWX REST API", - "current_version": "/api/v2/", - "available_versions": {"v2": "/api/v2/"}, - "oauth2": "/api/o/", - "custom_logo": "", - "custom_login_info": "", - "login_redirect_override": "", - "swagger": "/api/swagger/" - }) - }); -}); \ No newline at end of file + }); +}); diff --git a/test/Config.ts b/test/Config.ts new file mode 100644 index 0000000..e1faf6a --- /dev/null +++ b/test/Config.ts @@ -0,0 +1,8 @@ +import { Configuration, FetchAPI } from "awx-api-client"; + +export const configuration = new Configuration({ + username: "awx", + password: "awx", + basePath: `http://${global.__TESTCONTAINERS_AWX_IP__}:${global.__TESTCONTAINERS_AWX_PORT_8080__}`, + fetchApi: fetch as unknown as FetchAPI, +}); From 7f03bda57f4b3bc8364e8f4cf7d7cdaf98955644 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Thu, 10 Oct 2024 13:50:44 +1000 Subject: [PATCH 5/9] Run prettier on jest-container-config --- jest-testcontainers-config.js | 37 +++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/jest-testcontainers-config.js b/jest-testcontainers-config.js index 800ef3c..9675c59 100644 --- a/jest-testcontainers-config.js +++ b/jest-testcontainers-config.js @@ -1,16 +1,23 @@ module.exports = { - awx: { - image: 'wiremock/wiremock:3.9.1', - ports: [8080], - resourcesQuota: { - memory: 0.25 - }, - bindMounts: [{ - source: `${__dirname}/.awx`, - target: '/home/wiremock', - mode: 'rw' - }], - command: ['--verbose', '--disable-banner', '--record-mappings', - '--proxy-all', 'https://host.docker.internal:8043' ] - } -} \ No newline at end of file + awx: { + image: "wiremock/wiremock:3.9.1", + ports: [8080], + resourcesQuota: { + memory: 0.25, + }, + bindMounts: [ + { + source: `${__dirname}/.awx`, + target: "/home/wiremock", + mode: "rw", + }, + ], + command: [ + "--verbose", + "--disable-banner", + "--record-mappings", + "--proxy-all", + "https://host.docker.internal:8043", + ], + }, +}; From 557ca072ad9c6fd0ab82179913f2fdb4cd7c83b6 Mon Sep 17 00:00:00 2001 From: ryan-bennett Date: Fri, 11 Oct 2024 07:52:52 +1000 Subject: [PATCH 6/9] restructure project so that code can be debugged --- .gitignore | 4 ++-- generate.js | 2 +- package.json | 11 ++++++----- test/ApiApi.test.ts | 3 ++- test/Config.ts | 2 +- tsconfig.json | 3 ++- yarn.lock | 7 ++----- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index 4fa6a07..f7b7e21 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ dist -typescript-fetch-client node_modules .env .idea -awx \ No newline at end of file +awx +generated \ No newline at end of file diff --git a/generate.js b/generate.js index fe49941..3f88bd4 100644 --- a/generate.js +++ b/generate.js @@ -1,3 +1,3 @@ const {execSync} = require('child_process'); -execSync(`docker run --rm -v "${process.cwd()}:/local\" openapitools/openapi-generator-cli:v7.8.0 generate -i /local/spec.json -g typescript-fetch -o /local/typescript-fetch-client -p supportsES6=true -p npmName=awx-api-client -p npmVersion=1.0.0`); \ No newline at end of file +execSync(`docker run --rm -v "${process.cwd()}:/local\" openapitools/openapi-generator-cli:v7.9.0 generate -i /local/spec.json -g typescript-fetch -o /local/generated -p debugOpenAPI=true -p verbose=false -p supportsES6=false -p npmName=awx-api-client -p npmVersion=1.0.0`); \ No newline at end of file diff --git a/package.json b/package.json index 17f6ee2..d1a9610 100644 --- a/package.json +++ b/package.json @@ -13,20 +13,21 @@ "repositoryUrl": "https://github.com/eresearchqut/awx-api-client.git" }, "scripts": { + "awx:clean": "rimraf:awx", "awx:build": "(git -C awx pull || git clone -b devel https://github.com/ansible/awx.git awx) && (cd awx && make docker-compose-build && make clean/ui ui)", "awx:start": "(cd awx && make docker-compose)", "awx:superuser": "docker exec -ti tools_awx_1 awx-manage createsuperuser", - "clean": "rimraf awx && rimraf dist && rimraf generated && rimraf yarn-error.log && rimraf typescript-fetch-client && rimraf node_modules", + "clean": "rimraf dist && rimraf generated && rimraf yarn-error.log && rimraf node_modules", "regen": "(cd awx && make docker-compose)", "prebuild": "node ./generate.js", - "build": "node ./generate.js && (cd ./typescript-fetch-client && yarn install && yarn build)", - "test": "tsc && jest" + "build": "tsc", + "test": "jest" }, "dependencies": { - "awx-api-client": "./typescript-fetch-client" + }, "devDependencies": { - "@eresearchqut/jest-testcontainers": "^3.4.0", + "@eresearchqut/jest-testcontainers": "^3.6.4", "@types/jest": "^29.5.12", "@types/node": "^22.5.1", "dotenv": "^16.3.1", diff --git a/test/ApiApi.test.ts b/test/ApiApi.test.ts index c042eb2..97c0591 100644 --- a/test/ApiApi.test.ts +++ b/test/ApiApi.test.ts @@ -1,5 +1,6 @@ -import { ApiApi } from "awx-api-client"; + import { configuration } from "./Config"; +import {ApiApi} from "../generated/src"; describe("AWXApiTest", () => { const api = new ApiApi(configuration); diff --git a/test/Config.ts b/test/Config.ts index e1faf6a..8588475 100644 --- a/test/Config.ts +++ b/test/Config.ts @@ -1,4 +1,4 @@ -import { Configuration, FetchAPI } from "awx-api-client"; +import { Configuration, FetchAPI } from "../generated/src" export const configuration = new Configuration({ username: "awx", diff --git a/tsconfig.json b/tsconfig.json index 12891ba..3a4152a 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,6 +1,7 @@ { "include": [ - "./test/**/*" + "./test/**/*", + "./generated/**/*" ], "exclude": [ "node_modules", diff --git a/yarn.lock b/yarn.lock index b9a1784..02a0871 100644 --- a/yarn.lock +++ b/yarn.lock @@ -303,9 +303,9 @@ dependencies: "@jridgewell/trace-mapping" "0.3.9" -"@eresearchqut/jest-testcontainers@^3.4.0": +"@eresearchqut/jest-testcontainers@^3.6.4": version "3.6.4" - resolved "https://npm.pkg.github.com/download/@eresearchqut/jest-testcontainers/3.6.4/dd8077ee9c871e820d849f41f2548ac96486b587#dd8077ee9c871e820d849f41f2548ac96486b587" + resolved "https://registry.yarnpkg.com/@eresearchqut/jest-testcontainers/-/jest-testcontainers-3.6.4.tgz#dd8077ee9c871e820d849f41f2548ac96486b587" integrity sha512-flWCEEpnAG2MX9ZKe+y/m+evYW2bqeD5Cbt4Uf6lpt430Wnvb3u2R4Ebv97ubhUPU10HezK1kJA+UxClCNlsrg== dependencies: cwd "^0.10.0" @@ -881,9 +881,6 @@ async@^3.2.3, async@^3.2.4: resolved "https://registry.yarnpkg.com/async/-/async-3.2.6.tgz#1b0728e14929d51b85b449b7f06e27c1145e38ce" integrity sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA== -awx-api-client@./typescript-fetch-client: - version "1.0.0" - b4a@^1.6.4, b4a@^1.6.6: version "1.6.7" resolved "https://registry.yarnpkg.com/b4a/-/b4a-1.6.7.tgz#a99587d4ebbfbd5a6e3b21bdb5d5fa385767abe4" From a71cdaef0cf44e6f9c7afe7c8525f0a8c7ffabf3 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Fri, 11 Oct 2024 12:07:32 +1000 Subject: [PATCH 7/9] Added recording mapping for api --- .awx/__files/body-api-glzeX.json | 1 + .awx/mappings/mapping-api-glzeX.json | 32 ++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 .awx/__files/body-api-glzeX.json create mode 100644 .awx/mappings/mapping-api-glzeX.json diff --git a/.awx/__files/body-api-glzeX.json b/.awx/__files/body-api-glzeX.json new file mode 100644 index 0000000..bbff5b9 --- /dev/null +++ b/.awx/__files/body-api-glzeX.json @@ -0,0 +1 @@ +{"description":"AWX REST API","current_version":"/api/v2/","available_versions":{"v2":"/api/v2/"},"oauth2":"/api/o/","custom_logo":"","custom_login_info":"","login_redirect_override":"","swagger":"/api/swagger/"} \ No newline at end of file diff --git a/.awx/mappings/mapping-api-glzeX.json b/.awx/mappings/mapping-api-glzeX.json new file mode 100644 index 0000000..105464c --- /dev/null +++ b/.awx/mappings/mapping-api-glzeX.json @@ -0,0 +1,32 @@ +{ + "id" : "14c33444-1535-35fd-a492-2108d7a6e990", + "request" : { + "url" : "/api/", + "method" : "GET" + }, + "response" : { + "status" : 200, + "bodyFileName" : "body-api-glzeX.json", + "headers" : { + "X-API-Product-Name" : "AWX", + "Server" : "nginx", + "X-Content-Type-Options" : "nosniff", + "X-API-Query-Time" : "0.003s", + "X-API-Time" : "0.265s", + "Date" : "Fri, 11 Oct 2024 02:05:11 GMT", + "Allow" : "GET, HEAD, OPTIONS", + "Strict-Transport-Security" : "max-age=15768000", + "Access-Control-Expose-Headers" : "X-API-Request-Id", + "X-API-Total-Time" : "0.289s", + "X-API-Query-Count" : "2", + "Set-Cookie" : "csrftoken=Es54ugBVoHkMtDtE5raa0BapN7LHuOhe; Path=/; SameSite=Lax", + "X-API-Request-Id" : "dd4dddd64b7545e8808a4757052edcee", + "Vary" : "Accept, Cookie, Accept-Language, origin", + "X-API-Node" : "awx-1", + "X-API-Product-Version" : "24.6.2.dev128+g825a02c86a", + "Content-Language" : "en", + "Content-Type" : "application/json" + } + }, + "uuid" : "14c33444-1535-35fd-a492-2108d7a6e990" +} \ No newline at end of file From e059796f0fe0f8a89e240536c8b45a79d94b8986 Mon Sep 17 00:00:00 2001 From: Nick Pang Date: Fri, 11 Oct 2024 12:09:10 +1000 Subject: [PATCH 8/9] Updated spec.json to return json instead of void and rename test and removed console.log --- spec.json | 33666 +++++++++++++++++++++++++++++++++++++++++- test/ApiApi.test.ts | 3 +- 2 files changed, 33666 insertions(+), 3 deletions(-) diff --git a/spec.json b/spec.json index 082e8dc..a3e8582 100644 --- a/spec.json +++ b/spec.json @@ -1 +1,33665 @@ -{"swagger": "2.0", "info": {"title": "Snippets API", "description": "Test description", "termsOfService": "https://www.google.com/policies/terms/", "contact": {"email": "contact@snippets.local"}, "license": {"name": "BSD License"}, "version": "v1"}, "host": "localhost:8043", "schemes": ["https"], "basePath": "/", "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Basic": {"type": "basic"}}, "security": [{"Basic": []}], "paths": {"/api/": {"get": {"operationId": "api_list", "description": "List supported API versions", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/debug/": {"get": {"operationId": "api_debug_list", "description": "List of available debug urls", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/debug/dependency_manager/": {"get": {"operationId": "api_debug_dependency_manager_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/debug/task_manager/": {"get": {"operationId": "api_debug_task_manager_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/debug/workflow_manager/": {"get": {"operationId": "api_debug_workflow_manager_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/o/": {"get": {"operationId": "api_o_list", "summary": "# Token Handling using OAuth2", "description": "This page lists OAuth 2 utility endpoints used for authorization, token refresh and revoke.\nNote endpoints other than `/api/o/authorize/` are not meant to be used in browsers and do not\nsupport HTTP GET. The endpoints here strictly follow\n[RFC specs for OAuth2](https://tools.ietf.org/html/rfc6749), so please use that for detailed\nreference. Note AWX net location default to `http://localhost:8013` in examples:\n\n\n## Create Token for an Application using Authorization code grant type\nGiven an application \"AuthCodeApp\" of grant type `authorization-code`, \nfrom the client app, the user makes a GET to the Authorize endpoint with \n\n* `response_type`\n* `client_id`\n* `redirect_uris`\n* `scope` \n\nAWX will respond with the authorization `code` and `state`\nto the redirect_uri specified in the application. The client application will then make a POST to the\n`api/o/token/` endpoint on AWX with\n\n* `code`\n* `client_id`\n* `client_secret`\n* `grant_type`\n* `redirect_uri`\n\nAWX will respond with the `access_token`, `token_type`, `refresh_token`, and `expires_in`. For more\ninformation on testing this flow, refer to [django-oauth-toolkit](http://django-oauth-toolkit.readthedocs.io/en/latest/tutorial/tutorial_01.html#test-your-authorization-server).\n\n\n## Create Token for an Application using Password grant type\n\nLog in is not required for `password` grant type, so a simple `curl` can be used to acquire a personal access token\nvia `/api/o/token/` with \n\n* `grant_type`: Required to be \"password\"\n* `username`\n* `password`\n* `client_id`: Associated application must have grant_type \"password\"\n* `client_secret`\n\nFor example:\n\n```bash\ncurl -X POST \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=password&username=&password=&scope=read\" \\\n -u \"gwSPoasWSdNkMDtBN3Hu2WYQpPWCO9SwUEsKK22l:fI6ZpfocHYBGfm1tP92r0yIgCyfRdDQt0Tos9L8a4fNsJjQQMwp9569e\nIaUBsaVDgt2eiwOGe0bg5m5vCSstClZmtdy359RVx2rQK5YlIWyPlrolpt2LEpVeKXWaiybo\" \\\n http://localhost:8013/api/o/token/ -i\n```\nIn the above post request, parameters `username` and `password` are username and password of the related\nAWX user of the underlying application, and the authentication information is of format\n`:`, where `client_id` and `client_secret` are the corresponding fields of\nunderlying application.\n\nUpon success, access token, refresh token and other information are given in the response body in JSON", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/v2/role_definitions/": {"get": {"operationId": "api_v2_role_definitions_list", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleDefinition"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_v2_role_definitions_create", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleDefinition"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RoleDefinition"}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/role_definitions/{id}/": {"get": {"operationId": "api_v2_role_definitions_read", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RoleDefinition"}}}, "tags": ["api"]}, "put": {"operationId": "api_v2_role_definitions_update", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleDefinitionDetail"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RoleDefinitionDetail"}}}, "tags": ["api"]}, "patch": {"operationId": "api_v2_role_definitions_partial_update", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleDefinition"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RoleDefinition"}}}, "tags": ["api"]}, "delete": {"operationId": "api_v2_role_definitions_delete", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this role definition.", "required": true, "type": "integer"}]}, "/api/v2/role_definitions/{id}/team_assignments/": {"get": {"operationId": "api_v2_role_definitions_team_assignments_list", "summary": "Manage Role Team Assignment objects in the 'team_assignments' relationship of this particular Role Definition.", "description": "Starting from the detail URL:\n\nGET /:id/team_assignments/ to show role team assignments currently in the relationship", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleTeamAssignment"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/v2/role_definitions/{id}/user_assignments/": {"get": {"operationId": "api_v2_role_definitions_user_assignments_list", "summary": "Manage Role User Assignment objects in the 'user_assignments' relationship of this particular Role Definition.", "description": "Starting from the detail URL:\n\nGET /:id/user_assignments/ to show role user assignments currently in the relationship", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleUserAssignment"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/v2/role_metadata/": {"get": {"operationId": "api_v2_role_metadata_list", "summary": "General data about models and permissions tracked by django-ansible-base RBAC", "description": "Information from this endpoint should be static given a server version.\nThis reflects model definitions, registrations with the permission registry,\nand enablement of RBAC features in settings.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleMetadata"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/role_team_assignments/": {"get": {"operationId": "api_v2_role_team_assignments_list", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleTeamAssignment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_v2_role_team_assignments_create", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleTeamAssignment"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RoleTeamAssignment"}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/role_team_assignments/{id}/": {"get": {"operationId": "api_v2_role_team_assignments_read", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RoleTeamAssignment"}}}, "tags": ["api"]}, "delete": {"operationId": "api_v2_role_team_assignments_delete", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/v2/role_user_assignments/": {"get": {"operationId": "api_v2_role_user_assignments_list", "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleUserAssignment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_v2_role_user_assignments_create", "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleUserAssignment"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RoleUserAssignment"}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/role_user_assignments/{id}/": {"get": {"operationId": "api_v2_role_user_assignments_read", "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RoleUserAssignment"}}}, "tags": ["api"]}, "delete": {"operationId": "api_v2_role_user_assignments_delete", "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/v2/service-index/": {"get": {"operationId": "api_v2_service-index_list", "description": "Link other resource registry endpoints", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/v2/service-index/metadata/": {"get": {"operationId": "api_v2_service-index_metadata_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/v2/service-index/resource-types/": {"get": {"operationId": "api_v2_service-index_resource-types_list", "description": "Index of the resource types that are configured in the system.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceType"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/service-index/resource-types/{name}/": {"get": {"operationId": "api_v2_service-index_resource-types_read", "description": "Index of the resource types that are configured in the system.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ResourceType"}}}, "tags": ["api"]}, "parameters": [{"name": "name", "in": "path", "required": true, "type": "string", "pattern": "[^/]+"}]}, "/api/v2/service-index/resource-types/{name}/manifest/": {"get": {"operationId": "api_v2_service-index_resource-types_manifest", "description": "Returns the as a stream the csv of resource_id,hash for a given resource type.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ResourceType"}}}, "tags": ["api"]}, "parameters": [{"name": "name", "in": "path", "required": true, "type": "string", "pattern": "[^/]+"}]}, "/api/v2/service-index/resources/": {"get": {"operationId": "api_v2_service-index_resources_list", "description": "Index of all the resources in the system.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_v2_service-index_resources_create", "description": "Index of all the resources in the system.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Resource"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Resource"}}}, "tags": ["api"]}, "parameters": []}, "/api/v2/service-index/resources/{ansible_id}/": {"get": {"operationId": "api_v2_service-index_resources_read", "description": "Index of all the resources in the system.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Resource"}}}, "tags": ["api"]}, "put": {"operationId": "api_v2_service-index_resources_update", "description": "Index of all the resources in the system.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Resource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Resource"}}}, "tags": ["api"]}, "patch": {"operationId": "api_v2_service-index_resources_partial_update", "description": "Index of all the resources in the system.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Resource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Resource"}}}, "tags": ["api"]}, "delete": {"operationId": "api_v2_service-index_resources_delete", "description": "Index of all the resources in the system.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "ansible_id", "in": "path", "required": true, "type": "string", "format": "uuid"}]}, "/api/v2/service-index/resources/{ansible_id}/additional_data/": {"get": {"operationId": "api_v2_service-index_resources_additional_data", "description": "Index of all the resources in the system.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Resource"}}}, "tags": ["api"]}, "parameters": [{"name": "ansible_id", "in": "path", "required": true, "type": "string", "format": "uuid"}]}, "/api/v2/service-index/validate-local-account/": {"post": {"operationId": "api_v2_service-index_validate-local-account_create", "description": "Validate a user's username and password.", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/{version}/": {"get": {"operationId": "api_read", "description": "List top level resources", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/activity_stream/": {"get": {"operationId": "api_activity_stream_list", "summary": "# List Activity Streams:", "description": "Make a GET request to this resource to retrieve the list of\nactivity streams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/activity_stream/{id}/": {"get": {"operationId": "api_activity_stream_read", "summary": "# Retrieve an Activity Stream:", "description": "Make GET request to this resource to retrieve a single activity stream\nrecord containing the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ActivityStream"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_command_events/{id}/": {"get": {"operationId": "api_ad_hoc_command_events_read", "summary": "# Retrieve an Ad Hoc Command Event:", "description": "Make GET request to this resource to retrieve a single ad hoc command event\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandEvent"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/": {"get": {"operationId": "api_ad_hoc_commands_list", "summary": "# List Ad Hoc Commands:", "description": "Make a GET request to this resource to retrieve the list of\nad hoc commands.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_ad_hoc_commands_create", "summary": "# List Ad Hoc Commands:", "description": "Make a GET request to this resource to retrieve the list of\nad hoc commands.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandList"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/": {"get": {"operationId": "api_ad_hoc_commands_read", "summary": "# Retrieve an Ad Hoc Command:", "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n\n\n\n\n\n# Delete an Ad Hoc Command:\n\nMake a DELETE request to this resource to delete this ad hoc command.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_ad_hoc_commands_delete", "summary": "# Retrieve an Ad Hoc Command:", "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n\n\n\n\n\n# Delete an Ad Hoc Command:\n\nMake a DELETE request to this resource to delete this ad hoc command.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/activity_stream/": {"get": {"operationId": "api_ad_hoc_commands_activity_stream_list", "summary": "# List Activity Streams for an Ad Hoc Command:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/cancel/": {"get": {"operationId": "api_ad_hoc_commands_cancel_read", "summary": "# Retrieve an Ad Hoc Command:", "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_ad_hoc_commands_cancel_create", "summary": "# Retrieve an Ad Hoc Command:", "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/events/": {"get": {"operationId": "api_ad_hoc_commands_events_list", "summary": "# List Ad Hoc Command Events for an Ad Hoc Command:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc command events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command event records. \n\n## Results\n\nEach ad hoc command event data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that ad hoc command events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/notifications/": {"get": {"operationId": "api_ad_hoc_commands_notifications_list", "summary": "# List Notifications for an Ad Hoc Command:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/relaunch/": {"get": {"operationId": "api_ad_hoc_commands_relaunch_list", "summary": "Relaunch an Ad Hoc Command:", "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandRelaunch"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_ad_hoc_commands_relaunch_create", "summary": "Relaunch an Ad Hoc Command:", "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandRelaunch"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandRelaunch"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ad_hoc_commands/{id}/stdout/": {"get": {"operationId": "api_ad_hoc_commands_stdout_read", "summary": "# Retrieve Ad Hoc Command Stdout:", "description": "Make GET request to this resource to retrieve the stdout from running this\nad hoc command.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UnifiedJobStdout"}}}, "produces": ["text/plain", "text/plain", "application/json", "text/plain", "text/plain"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/": {"get": {"operationId": "api_analytics_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/adoption_rate/": {"get": {"operationId": "api_analytics_adoption_rate_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_adoption_rate_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/adoption_rate_options/": {"get": {"operationId": "api_analytics_adoption_rate_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_adoption_rate_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/authorized/": {"get": {"operationId": "api_analytics_authorized_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_authorized_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/event_explorer/": {"get": {"operationId": "api_analytics_event_explorer_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_event_explorer_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/event_explorer_options/": {"get": {"operationId": "api_analytics_event_explorer_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_event_explorer_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/host_explorer/": {"get": {"operationId": "api_analytics_host_explorer_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_host_explorer_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/host_explorer_options/": {"get": {"operationId": "api_analytics_host_explorer_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_host_explorer_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/job_explorer/": {"get": {"operationId": "api_analytics_job_explorer_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_job_explorer_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/job_explorer_options/": {"get": {"operationId": "api_analytics_job_explorer_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_job_explorer_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/probe_template_for_hosts/": {"get": {"operationId": "api_analytics_probe_template_for_hosts_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_probe_template_for_hosts_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/probe_template_for_hosts_options/": {"get": {"operationId": "api_analytics_probe_template_for_hosts_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_probe_template_for_hosts_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/probe_templates/": {"get": {"operationId": "api_analytics_probe_templates_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_probe_templates_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/probe_templates_options/": {"get": {"operationId": "api_analytics_probe_templates_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_probe_templates_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/report/{slug}/": {"get": {"operationId": "api_analytics_report_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_report_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "slug", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/report_options/": {"get": {"operationId": "api_analytics_report_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_report_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/reports/": {"get": {"operationId": "api_analytics_reports_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_reports_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/roi_templates/": {"get": {"operationId": "api_analytics_roi_templates_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_roi_templates_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/analytics/roi_templates_options/": {"get": {"operationId": "api_analytics_roi_templates_options_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_analytics_roi_templates_options_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/applications/": {"get": {"operationId": "api_applications_list", "summary": "# List Applications:", "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Application"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_applications_create", "summary": "# List Applications:", "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Application"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/applications/{id}/": {"get": {"operationId": "api_applications_read", "summary": "# Retrieve an Application:", "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "put": {"operationId": "api_applications_update", "summary": "# Retrieve an Application:", "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Application"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "patch": {"operationId": "api_applications_partial_update", "summary": "# Retrieve an Application:", "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Application"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "delete": {"operationId": "api_applications_delete", "summary": "# Retrieve an Application:", "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/applications/{id}/activity_stream/": {"get": {"operationId": "api_applications_activity_stream_list", "summary": "# List Activity Streams for an Application:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/applications/{id}/tokens/": {"get": {"operationId": "api_applications_tokens_list", "summary": "# List Access Tokens for an Application:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Token"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_applications_tokens_create", "summary": "# List Access Tokens for an Application:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Token"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Token"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/auth/": {"get": {"operationId": "api_auth_list", "description": "List enabled single-sign-on endpoints", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/bulk/": {"get": {"operationId": "api_bulk_list", "description": "List top level resources", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/bulk/host_create/": {"get": {"operationId": "api_bulk_host_create_list", "summary": "# Bulk Host Create", "description": "This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/BulkHostCreate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_bulk_host_create_create", "summary": "# Bulk Host Create", "description": "This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BulkHostCreate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/BulkHostCreate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/bulk/host_delete/": {"get": {"operationId": "api_bulk_host_delete_list", "summary": "# Bulk Host Delete", "description": "This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/BulkHostDelete"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_bulk_host_delete_create", "summary": "# Bulk Host Delete", "description": "This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BulkHostDelete"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/BulkHostDelete"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/bulk/job_launch/": {"get": {"operationId": "api_bulk_job_launch_list", "summary": "# Bulk Job Launch", "description": "This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/BulkJobLaunch"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_bulk_job_launch_create", "summary": "# Bulk Job Launch", "description": "This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BulkJobLaunch"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/BulkJobLaunch"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/config/": {"get": {"operationId": "api_config_list", "description": "Return various sitewide configuration settings", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_config_create", "summary": "# Site configuration settings and general information", "description": "Make a GET request to this resource to retrieve the configuration containing\nthe following fields (some fields may not be visible to all users):\n\n* `project_base_dir`: Path on the server where projects and playbooks are \\\n stored.\n* `project_local_paths`: List of directories beneath `project_base_dir` to\n use when creating/editing a manual project.\n* `time_zone`: The configured time zone for the server.\n* `license_info`: Information about the current license.\n* `version`: Version of Ansible Tower package installed.\n* `custom_virtualenvs`: Deprecated venv locations from before migration to\n execution environments. Export tooling is in `awx-manage` commands.\n* `eula`: The current End-User License Agreement\n\n\n\n# Install or update an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a POST request to this resource as a super\nuser to install or update the existing license. The license data itself can\nbe POSTed as a normal json data structure.\n\n(_New in Ansible Tower 2.1.1_) The POST must include a `eula_accepted` boolean\nelement indicating acceptance of the End-User License Agreement.\n\n\n\n# Delete an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a DELETE request to this resource as a super\nuser to delete the existing license", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "delete": {"operationId": "api_config_delete", "summary": "# Site configuration settings and general information", "description": "Make a GET request to this resource to retrieve the configuration containing\nthe following fields (some fields may not be visible to all users):\n\n* `project_base_dir`: Path on the server where projects and playbooks are \\\n stored.\n* `project_local_paths`: List of directories beneath `project_base_dir` to\n use when creating/editing a manual project.\n* `time_zone`: The configured time zone for the server.\n* `license_info`: Information about the current license.\n* `version`: Version of Ansible Tower package installed.\n* `custom_virtualenvs`: Deprecated venv locations from before migration to\n execution environments. Export tooling is in `awx-manage` commands.\n* `eula`: The current End-User License Agreement\n\n\n\n# Install or update an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a POST request to this resource as a super\nuser to install or update the existing license. The license data itself can\nbe POSTed as a normal json data structure.\n\n(_New in Ansible Tower 2.1.1_) The POST must include a `eula_accepted` boolean\nelement indicating acceptance of the End-User License Agreement.\n\n\n\n# Delete an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a DELETE request to this resource as a super\nuser to delete the existing license", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/config/attach/": {"post": {"operationId": "api_config_attach_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/config/subscriptions/": {"post": {"operationId": "api_config_subscriptions_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/constructed_inventories/": {"get": {"operationId": "api_constructed_inventories_list", "summary": "# List Inventories:", "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ConstructedInventory"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_constructed_inventories_create", "summary": "# List Inventories:", "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ConstructedInventory"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ConstructedInventory"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/constructed_inventories/{id}/": {"get": {"operationId": "api_constructed_inventories_read", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ConstructedInventory"}}}, "tags": ["api"]}, "put": {"operationId": "api_constructed_inventories_update", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ConstructedInventory"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ConstructedInventory"}}}, "tags": ["api"]}, "patch": {"operationId": "api_constructed_inventories_partial_update", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ConstructedInventory"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ConstructedInventory"}}}, "tags": ["api"]}, "delete": {"operationId": "api_constructed_inventories_delete", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_input_sources/": {"get": {"operationId": "api_credential_input_sources_list", "summary": "# List Credential Input Sources:", "description": "Make a GET request to this resource to retrieve the list of\ncredential input sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CredentialInputSource"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credential_input_sources_create", "summary": "# List Credential Input Sources:", "description": "Make a GET request to this resource to retrieve the list of\ncredential input sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialInputSource"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CredentialInputSource"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_input_sources/{id}/": {"get": {"operationId": "api_credential_input_sources_read", "summary": "# Retrieve a Credential Input Source:", "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialInputSource"}}}, "tags": ["api"]}, "put": {"operationId": "api_credential_input_sources_update", "summary": "# Retrieve a Credential Input Source:", "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialInputSource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialInputSource"}}}, "tags": ["api"]}, "patch": {"operationId": "api_credential_input_sources_partial_update", "summary": "# Retrieve a Credential Input Source:", "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialInputSource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialInputSource"}}}, "tags": ["api"]}, "delete": {"operationId": "api_credential_input_sources_delete", "summary": "# Retrieve a Credential Input Source:", "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_types/": {"get": {"operationId": "api_credential_types_list", "summary": "# List Credential Types:", "description": "Make a GET request to this resource to retrieve the list of\ncredential types.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential types\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential type records. \n\n## Results\n\nEach credential type data structure includes the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n## Sorting\n\nTo specify that credential types are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CredentialType"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credential_types_create", "summary": "# List Credential Types:", "description": "Make a GET request to this resource to retrieve the list of\ncredential types.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential types\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential type records. \n\n## Results\n\nEach credential type data structure includes the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n## Sorting\n\nTo specify that credential types are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialType"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CredentialType"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_types/{id}/": {"get": {"operationId": "api_credential_types_read", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialType"}}}, "tags": ["api"]}, "put": {"operationId": "api_credential_types_update", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialType"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialType"}}}, "tags": ["api"]}, "patch": {"operationId": "api_credential_types_partial_update", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialType"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CredentialType"}}}, "tags": ["api"]}, "delete": {"operationId": "api_credential_types_delete", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_types/{id}/activity_stream/": {"get": {"operationId": "api_credential_types_activity_stream_list", "summary": "# List Activity Streams for a Credential Type:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_types/{id}/credentials/": {"get": {"operationId": "api_credential_types_credentials_list", "summary": "# List Credentials for a Credential Type:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credential_types_credentials_create", "summary": "# List Credentials for a Credential Type:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credential_types/{id}/test/": {"get": {"operationId": "api_credential_types_test_read", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "post": {"operationId": "api_credential_types_test_create", "summary": "# Retrieve a Credential Type:", "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/": {"get": {"operationId": "api_credentials_list", "summary": "# List Credentials:", "description": "Make a GET request to this resource to retrieve the list of\ncredentials.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CredentialSerializerCreate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credentials_create", "summary": "# List Credentials:", "description": "Make a GET request to this resource to retrieve the list of\ncredentials.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialSerializerCreate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CredentialSerializerCreate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/": {"get": {"operationId": "api_credentials_read", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "put": {"operationId": "api_credentials_update", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "patch": {"operationId": "api_credentials_partial_update", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "delete": {"operationId": "api_credentials_delete", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/access_list/": {"get": {"operationId": "api_credentials_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/activity_stream/": {"get": {"operationId": "api_credentials_activity_stream_list", "summary": "# List Activity Streams for a Credential:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/copy/": {"get": {"operationId": "api_credentials_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credentials_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/input_sources/": {"get": {"operationId": "api_credentials_input_sources_list", "summary": "# List Credential Input Sources for a Credential:", "description": "Make a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CredentialInputSource"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_credentials_input_sources_create", "summary": "# List Credential Input Sources for a Credential:", "description": "Make a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CredentialInputSource"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CredentialInputSource"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/object_roles/": {"get": {"operationId": "api_credentials_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Credential:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/owner_teams/": {"get": {"operationId": "api_credentials_owner_teams_list", "summary": "# List Teams for a Credential:", "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/owner_users/": {"get": {"operationId": "api_credentials_owner_users_list", "summary": "# List Users for a Credential:", "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/credentials/{id}/test/": {"get": {"operationId": "api_credentials_test_read", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "post": {"operationId": "api_credentials_test_create", "summary": "# Retrieve a Credential:", "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/dashboard/": {"get": {"operationId": "api_dashboard_list", "description": "Show Dashboard Details", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/dashboard/graphs/jobs/": {"get": {"operationId": "api_dashboard_graphs_jobs_list", "summary": "# View Statistics for Job Runs", "description": "Make a GET request to this resource to retrieve aggregate statistics about job runs suitable for graphing.\n\n## Parameters and Filtering\n\nThe `period` of the data can be adjusted with:\n\n ?period=month\n\nWhere `month` can be replaced with `week`, `two_weeks`, or `day`. `month` is the default.\n\nThe type of job can be filtered with:\n\n ?job_type=all\n\nWhere `all` can be replaced with `inv_sync`, `playbook_run` or `scm_update`. `all` is the default.\n\n## Results\n\nData will be returned in the following format:\n\n \"jobs\": {\n \"successful\": [\n [\n 1402808400.0, \n 9\n ], ... ],\n \"failed\": [\n \t [\n 1402808400.0, \n 3\n ], ... ]\n }\n\nEach element contains an epoch timestamp represented in seconds and a numerical value indicating\nthe number of events during that time period", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/execution_environments/": {"get": {"operationId": "api_execution_environments_list", "summary": "# List Execution Environments:", "description": "Make a GET request to this resource to retrieve the list of\nexecution environments.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ExecutionEnvironment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_execution_environments_create", "summary": "# List Execution Environments:", "description": "Make a GET request to this resource to retrieve the list of\nexecution environments.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/execution_environments/{id}/": {"get": {"operationId": "api_execution_environments_read", "summary": "# Retrieve an Execution Environment:", "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}}, "tags": ["api"]}, "put": {"operationId": "api_execution_environments_update", "summary": "# Retrieve an Execution Environment:", "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}}, "tags": ["api"]}, "patch": {"operationId": "api_execution_environments_partial_update", "summary": "# Retrieve an Execution Environment:", "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}}, "tags": ["api"]}, "delete": {"operationId": "api_execution_environments_delete", "summary": "# Retrieve an Execution Environment:", "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/execution_environments/{id}/activity_stream/": {"get": {"operationId": "api_execution_environments_activity_stream_list", "summary": "# List Activity Streams for an Execution Environment:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nexecution environment.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/execution_environments/{id}/copy/": {"get": {"operationId": "api_execution_environments_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_execution_environments_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/execution_environments/{id}/unified_job_templates/": {"get": {"operationId": "api_execution_environments_unified_job_templates_list", "summary": "# List Unified Job Templates for an Execution Environment:", "description": "Make a GET request to this resource to retrieve a list of\nunified job templates associated with the selected\nexecution environment.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job template records. \n\n## Results\n\nEach unified job template data structure includes the following fields:\n\n* `id`: Database ID for this unified job template. (integer)\n* `type`: Data type for this unified job template. (choice)\n* `url`: URL for this unified job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job template was created. (datetime)\n* `modified`: Timestamp when this unified job template was last modified. (datetime)\n* `name`: Name of this unified job template. (string)\n* `description`: Optional description of this unified job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n\n\n\n## Sorting\n\nTo specify that unified job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobTemplate"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/": {"get": {"operationId": "api_groups_list", "summary": "# List Groups:", "description": "Make a GET request to this resource to retrieve the list of\ngroups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_groups_create", "summary": "# List Groups:", "description": "Make a GET request to this resource to retrieve the list of\ngroups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/": {"get": {"operationId": "api_groups_read", "summary": "# Retrieve a Group:", "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "put": {"operationId": "api_groups_update", "summary": "# Retrieve a Group:", "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "patch": {"operationId": "api_groups_partial_update", "summary": "# Retrieve a Group:", "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "delete": {"operationId": "api_groups_delete", "summary": "# Retrieve a Group:", "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/activity_stream/": {"get": {"operationId": "api_groups_activity_stream_list", "summary": "# List Activity Streams for a Group:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/ad_hoc_commands/": {"get": {"operationId": "api_groups_ad_hoc_commands_list", "summary": "# List Ad Hoc Commands for a Group:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_groups_ad_hoc_commands_create", "summary": "# List Ad Hoc Commands for a Group:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandList"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/all_hosts/": {"get": {"operationId": "api_groups_all_hosts_list", "summary": "# List All Hosts for a Group:", "description": "Make a GET request to this resource to retrieve a list of all\nhosts directly or indirectly belonging to this\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Host"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/children/": {"get": {"operationId": "api_groups_children_list", "summary": "# List Groups for a Group:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_groups_children_create", "summary": "# List Groups for a Group:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/hosts/": {"get": {"operationId": "api_groups_hosts_list", "summary": "# List Hosts for a Group:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Host"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_groups_hosts_create", "summary": "# List Hosts for a Group:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Host"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/inventory_sources/": {"get": {"operationId": "api_groups_inventory_sources_list", "summary": "# List Inventory Sources for a Group:", "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventorySource"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/job_events/": {"get": {"operationId": "api_groups_job_events_list", "summary": "# List Job Events for a Group:", "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/job_host_summaries/": {"get": {"operationId": "api_groups_job_host_summaries_list", "summary": "# List Job Host Summaries for a Group:", "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobHostSummary"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/potential_children/": {"get": {"operationId": "api_groups_potential_children_list", "summary": "# List Potential Child Groups for a Group:", "description": "Make a GET request to this resource to retrieve a list of\ngroups available to be added as children of the\ncurrent group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/groups/{id}/variable_data/": {"get": {"operationId": "api_groups_variable_data_read", "summary": "# Retrieve Group Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GroupVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "put": {"operationId": "api_groups_variable_data_update", "summary": "# Retrieve Group Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/GroupVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GroupVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "patch": {"operationId": "api_groups_variable_data_partial_update", "summary": "# Retrieve Group Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/GroupVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GroupVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/host_metric_summary_monthly/": {"get": {"operationId": "api_host_metric_summary_monthly_list", "summary": "# List Host Metric Summary Monthlys:", "description": "Make a GET request to this resource to retrieve the list of\nhost metric summary monthlys.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of host metric summary monthlys\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host metric summary monthly records. \n\n## Results\n\nEach host metric summary monthly data structure includes the following fields:\n\n* `id`: Database ID for this host metric summary monthly. (integer)\n* `date`: (date)\n* `license_consumed`: How many unique hosts are consumed from the license (integer)\n* `license_capacity`: 'License capacity as max. number of unique hosts (integer)\n* `hosts_added`: How many hosts were added in the associated month, consuming more license capacity (integer)\n* `hosts_deleted`: How many hosts were deleted in the associated month, freeing the license capacity (integer)\n* `indirectly_managed_hosts`: Manually entered number indirectly managed hosts for a certain month (integer)\n\n\n\n## Sorting\n\nTo specify that host metric summary monthlys are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/HostMetricSummaryMonthly"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/host_metrics/": {"get": {"operationId": "api_host_metrics_list", "summary": "# List Host Metrics:", "description": "Make a GET request to this resource to retrieve the list of\nhost metrics.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of host metrics\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host metric records. \n\n## Results\n\nEach host metric data structure includes the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n## Sorting\n\nTo specify that host metrics are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/HostMetric"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/host_metrics/{id}/": {"get": {"operationId": "api_host_metrics_read", "summary": "# Retrieve a Host Metric:", "description": "Make GET request to this resource to retrieve a single host metric\nrecord containing the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n\n\n# Delete a Host Metric:\n\nMake a DELETE request to this resource to soft-delete this host metric.\n\nA soft deletion will mark the `deleted` field as true and exclude the host\nmetric from license calculations.\nThis may be undone later if the same hostname is automated again afterwards.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/HostMetric"}}}, "tags": ["api"]}, "delete": {"operationId": "api_host_metrics_delete", "summary": "# Retrieve a Host Metric:", "description": "Make GET request to this resource to retrieve a single host metric\nrecord containing the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n\n\n# Delete a Host Metric:\n\nMake a DELETE request to this resource to soft-delete this host metric.\n\nA soft deletion will mark the `deleted` field as true and exclude the host\nmetric from license calculations.\nThis may be undone later if the same hostname is automated again afterwards.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/": {"get": {"operationId": "api_hosts_list", "summary": "# List Hosts:", "description": "Make a GET request to this resource to retrieve the list of\nhosts.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Host"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_hosts_create", "summary": "# List Hosts:", "description": "Make a GET request to this resource to retrieve the list of\nhosts.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Host"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/": {"get": {"operationId": "api_hosts_read", "summary": "# Retrieve a Host:", "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "put": {"operationId": "api_hosts_update", "summary": "# Retrieve a Host:", "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Host"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "patch": {"operationId": "api_hosts_partial_update", "summary": "# Retrieve a Host:", "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Host"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "delete": {"operationId": "api_hosts_delete", "summary": "# Retrieve a Host:", "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/activity_stream/": {"get": {"operationId": "api_hosts_activity_stream_list", "summary": "# List Activity Streams for a Host:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/ad_hoc_command_events/": {"get": {"operationId": "api_hosts_ad_hoc_command_events_list", "summary": "# List Ad Hoc Command Events for a Host:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc command events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command event records. \n\n## Results\n\nEach ad hoc command event data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that ad hoc command events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/ad_hoc_commands/": {"get": {"operationId": "api_hosts_ad_hoc_commands_list", "summary": "# List Ad Hoc Commands for a Host:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_hosts_ad_hoc_commands_create", "summary": "# List Ad Hoc Commands for a Host:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandList"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/all_groups/": {"get": {"operationId": "api_hosts_all_groups_list", "summary": "# List All Groups for a Host:", "description": "Make a GET request to this resource to retrieve a list of all\ngroups of which the selected\nhost is directly or indirectly a member.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/ansible_facts/": {"get": {"operationId": "api_hosts_ansible_facts_read", "summary": "# Retrieve a Host:", "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AnsibleFacts"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/groups/": {"get": {"operationId": "api_hosts_groups_list", "summary": "# List Groups for a Host:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_hosts_groups_create", "summary": "# List Groups for a Host:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/inventory_sources/": {"get": {"operationId": "api_hosts_inventory_sources_list", "summary": "# List Inventory Sources for a Host:", "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventorySource"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/job_events/": {"get": {"operationId": "api_hosts_job_events_list", "summary": "# List Job Events for a Host:", "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/job_host_summaries/": {"get": {"operationId": "api_hosts_job_host_summaries_list", "summary": "# List Job Host Summaries for a Host:", "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobHostSummary"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/smart_inventories/": {"get": {"operationId": "api_hosts_smart_inventories_list", "summary": "# List Inventories for a Host:", "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Inventory"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/hosts/{id}/variable_data/": {"get": {"operationId": "api_hosts_variable_data_read", "summary": "# Retrieve Host Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/HostVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "put": {"operationId": "api_hosts_variable_data_update", "summary": "# Retrieve Host Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/HostVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/HostVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "patch": {"operationId": "api_hosts_variable_data_partial_update", "summary": "# Retrieve Host Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/HostVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/HostVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/": {"get": {"operationId": "api_instance_groups_list", "summary": "# List Instance Groups:", "description": "Make a GET request to this resource to retrieve the list of\ninstance groups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_instance_groups_create", "summary": "# List Instance Groups:", "description": "Make a GET request to this resource to retrieve the list of\ninstance groups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/{id}/": {"get": {"operationId": "api_instance_groups_read", "summary": "# Retrieve an Instance Group:", "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "put": {"operationId": "api_instance_groups_update", "summary": "# Retrieve an Instance Group:", "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "patch": {"operationId": "api_instance_groups_partial_update", "summary": "# Retrieve an Instance Group:", "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "delete": {"operationId": "api_instance_groups_delete", "summary": "# Retrieve an Instance Group:", "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/{id}/access_list/": {"get": {"operationId": "api_instance_groups_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/{id}/instances/": {"get": {"operationId": "api_instance_groups_instances_list", "summary": "# List Instances for an Instance Group:", "description": "Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Instance"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_instance_groups_instances_create", "summary": "# List Instances for an Instance Group:", "description": "Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Instance"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Instance"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/{id}/jobs/": {"get": {"operationId": "api_instance_groups_jobs_list", "summary": "# List Unified Jobs for an Instance Group:", "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instance_groups/{id}/object_roles/": {"get": {"operationId": "api_instance_groups_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for an Instance Group:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/": {"get": {"operationId": "api_instances_list", "summary": "# List Instances:", "description": "Make a GET request to this resource to retrieve the list of\ninstances.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Instance"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_instances_create", "summary": "# List Instances:", "description": "Make a GET request to this resource to retrieve the list of\ninstances.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Instance"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Instance"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/": {"get": {"operationId": "api_instances_read", "summary": "# Retrieve an Instance:", "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Instance"}}}, "tags": ["api"]}, "put": {"operationId": "api_instances_update", "summary": "# Retrieve an Instance:", "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Instance"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Instance"}}}, "tags": ["api"]}, "patch": {"operationId": "api_instances_partial_update", "summary": "# Retrieve an Instance:", "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Instance"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Instance"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/health_check/": {"get": {"operationId": "api_instances_health_check_list", "summary": "# Health Check Data", "description": "Health checks are used to obtain important data about an instance.\nInstance fields affected by the health check are shown in this view.\nFundamentally, health checks require running code on the machine in question.\n\n - For instances with `node_type` of \"control\" or \"hybrid\", health checks are\nperformed as part of a periodic task that runs in the background.\n - For instances with `node_type` of \"execution\", health checks are done by submitting\na work unit through the receptor mesh.\n\nIf ran through the receptor mesh, the invoked command is:\n\n```\nansible-runner worker --worker-info\n```\n\nFor execution nodes, these checks are _not_ performed on a regular basis.\nHealth checks against functional nodes will be ran when the node is first discovered.\nHealth checks against nodes with errors will be repeated at a reduced frequency.\n\n\n\n\n# Manually Initiate a Health Check\nFor purposes of error remediation or debugging, a health check can be\nmanually initiated by making a POST request to this endpoint.\n\nThis will submit the work unit to the target node through the receptor mesh and wait for it to finish.\nThe model will be updated with the result.\nUp-to-date values of the fields will be returned in the response data.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceHealthCheck"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_instances_health_check_create", "summary": "# Health Check Data", "description": "Health checks are used to obtain important data about an instance.\nInstance fields affected by the health check are shown in this view.\nFundamentally, health checks require running code on the machine in question.\n\n - For instances with `node_type` of \"control\" or \"hybrid\", health checks are\nperformed as part of a periodic task that runs in the background.\n - For instances with `node_type` of \"execution\", health checks are done by submitting\na work unit through the receptor mesh.\n\nIf ran through the receptor mesh, the invoked command is:\n\n```\nansible-runner worker --worker-info\n```\n\nFor execution nodes, these checks are _not_ performed on a regular basis.\nHealth checks against functional nodes will be ran when the node is first discovered.\nHealth checks against nodes with errors will be repeated at a reduced frequency.\n\n\n\n\n# Manually Initiate a Health Check\nFor purposes of error remediation or debugging, a health check can be\nmanually initiated by making a POST request to this endpoint.\n\nThis will submit the work unit to the target node through the receptor mesh and wait for it to finish.\nThe model will be updated with the result.\nUp-to-date values of the fields will be returned in the response data.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceHealthCheck"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceHealthCheck"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/install_bundle/": {"get": {"operationId": "api_instances_install_bundle_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Instance"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/instance_groups/": {"get": {"operationId": "api_instances_instance_groups_list", "summary": "# List Instance Groups for an Instance:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_instances_instance_groups_create", "summary": "# List Instance Groups for an Instance:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/jobs/": {"get": {"operationId": "api_instances_jobs_list", "summary": "# List Unified Jobs for an Instance:", "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/peers/": {"get": {"operationId": "api_instances_peers_list", "summary": "# List Receptor Addresss for an Instance:", "description": "Make a GET request to this resource to retrieve a list of\nreceptor addresss associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ReceptorAddress"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/instances/{id}/receptor_addresses/": {"get": {"operationId": "api_instances_receptor_addresses_list", "summary": "# List Receptor Addresss for an Instance:", "description": "Make a GET request to this resource to retrieve a list of\nreceptor addresss associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ReceptorAddress"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/": {"get": {"operationId": "api_inventories_list", "summary": "# List Inventories:", "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Inventory"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_create", "summary": "# List Inventories:", "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Inventory"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Inventory"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/": {"get": {"operationId": "api_inventories_read", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Inventory"}}}, "tags": ["api"]}, "put": {"operationId": "api_inventories_update", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Inventory"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Inventory"}}}, "tags": ["api"]}, "patch": {"operationId": "api_inventories_partial_update", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Inventory"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Inventory"}}}, "tags": ["api"]}, "delete": {"operationId": "api_inventories_delete", "summary": "# Retrieve an Inventory:", "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/access_list/": {"get": {"operationId": "api_inventories_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/activity_stream/": {"get": {"operationId": "api_inventories_activity_stream_list", "summary": "# List Activity Streams for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/ad_hoc_commands/": {"get": {"operationId": "api_inventories_ad_hoc_commands_list", "summary": "# List Ad Hoc Commands for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdHocCommandList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_ad_hoc_commands_create", "summary": "# List Ad Hoc Commands for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AdHocCommandList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AdHocCommandList"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/copy/": {"get": {"operationId": "api_inventories_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/groups/": {"get": {"operationId": "api_inventories_groups_list", "summary": "# List Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_groups_create", "summary": "# List Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/hosts/": {"get": {"operationId": "api_inventories_hosts_list", "summary": "# List Hosts for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Host"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_hosts_create", "summary": "# List Hosts for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Host"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Host"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/input_inventories/": {"get": {"operationId": "api_inventories_input_inventories_list", "summary": "# List Inventories for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Inventory"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_input_inventories_create", "summary": "# List Inventories for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Inventory"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Inventory"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/instance_groups/": {"get": {"operationId": "api_inventories_instance_groups_list", "summary": "# List Instance Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_instance_groups_create", "summary": "# List Instance Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/inventory_sources/": {"get": {"operationId": "api_inventories_inventory_sources_list", "summary": "# List Inventory Sources for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventorySource"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_inventory_sources_create", "summary": "# List Inventory Sources for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySource"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InventorySource"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/job_templates/": {"get": {"operationId": "api_inventories_job_templates_list", "summary": "# List Job Templates for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobTemplate"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/labels/": {"get": {"operationId": "api_inventories_labels_list", "summary": "# List Labels for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_labels_create", "summary": "# List Labels for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/object_roles/": {"get": {"operationId": "api_inventories_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for an Inventory:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/root_groups/": {"get": {"operationId": "api_inventories_root_groups_list", "summary": "# List Root Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_root_groups_create", "summary": "# List Root Groups for an Inventory:", "description": "Make a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/script/": {"get": {"operationId": "api_inventories_script_read", "summary": "Generate inventory group and host data as needed for an inventory script.", "description": "Refer to [Dynamic Inventory](http://docs.ansible.com/intro_dynamic_inventory.html)\nfor more information on inventory scripts.\n\n## List Response\n\nMake a GET request to this resource without query parameters to retrieve a JSON\nobject containing groups, including the hosts, children and variables for each\ngroup. The response data is equivalent to that returned by passing the\n`--list` argument to an inventory script.\n\nSpecify a query string of `?hostvars=1` to retrieve the JSON\nobject above including all host variables. The `['_meta']['hostvars']` object\nin the response contains an entry for each host with its variables. This\nresponse format can be used with Ansible 1.3 and later to avoid making a\nseparate API request for each host. Refer to\n[Tuning the External Inventory Script](http://docs.ansible.com/developing_inventory.html#tuning-the-external-inventory-script)\nfor more information on this feature.\n\nBy default, the inventory script will only return hosts that\nare enabled in the inventory. This feature allows disabled hosts to be skipped\nwhen running jobs without removing them from the inventory. Specify a query\nstring of `?all=1` to return all hosts, including disabled ones.\n\nSpecify a query string of `?towervars=1` to add variables\nto the hostvars of each host that specifies its enabled state and database ID.\n\nSpecify a query string of `?subset=slice2of5` to produce an inventory that\nhas a restricted number of hosts according to the rules of job slicing.\n\nTo apply multiple query strings, join them with the `&` character, like `?hostvars=1&all=1`.\n\n## Host Response\n\nMake a GET request to this resource with a query string similar to\n`?host=HOSTNAME` to retrieve a JSON object containing host variables for the\nspecified host. The response data is equivalent to that returned by passing\nthe `--host HOSTNAME` argument to an inventory script.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryScript"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/tree/": {"get": {"operationId": "api_inventories_tree_read", "summary": "# Group Tree for an Inventory:", "description": "Make a GET request to this resource to retrieve a hierarchical view of groups\nassociated with the selected inventory.\n\nThe resulting data structure contains a list of root groups, with each group\nalso containing a list of its children.\n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n* `children`: (field)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GroupTree"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/update_inventory_sources/": {"get": {"operationId": "api_inventories_update_inventory_sources_read", "summary": "# Update Inventory Sources", "description": "Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:\n\n* `inventory_source`: ID of the inventory_source\n (integer, read-only)\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:\n\n* `status`: `started` or message why the update could not be started.\n (string, read-only)\n* `inventory_update`: ID of the inventory update job that was started.\n (integer, read-only)\n* `project_update`: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}}, "tags": ["api"]}, "post": {"operationId": "api_inventories_update_inventory_sources_create", "summary": "# Update Inventory Sources", "description": "Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:\n\n* `inventory_source`: ID of the inventory_source\n (integer, read-only)\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:\n\n* `status`: `started` or message why the update could not be started.\n (string, read-only)\n* `inventory_update`: ID of the inventory update job that was started.\n (integer, read-only)\n* `project_update`: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventories/{id}/variable_data/": {"get": {"operationId": "api_inventories_variable_data_read", "summary": "# Retrieve Inventory Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "put": {"operationId": "api_inventories_variable_data_update", "summary": "# Retrieve Inventory Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventoryVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "patch": {"operationId": "api_inventories_variable_data_partial_update", "summary": "# Retrieve Inventory Variable Data:", "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventoryVariableData"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryVariableData"}}}, "consumes": ["application/json", "application/yaml"], "produces": ["application/json", "application/yaml"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/": {"get": {"operationId": "api_inventory_sources_list", "summary": "# List Inventory Sources:", "description": "Make a GET request to this resource to retrieve the list of\ninventory sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventorySource"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_create", "summary": "# List Inventory Sources:", "description": "Make a GET request to this resource to retrieve the list of\ninventory sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySource"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InventorySource"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/": {"get": {"operationId": "api_inventory_sources_read", "summary": "# Retrieve an Inventory Source:", "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventorySource"}}}, "tags": ["api"]}, "put": {"operationId": "api_inventory_sources_update", "summary": "# Retrieve an Inventory Source:", "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventorySource"}}}, "tags": ["api"]}, "patch": {"operationId": "api_inventory_sources_partial_update", "summary": "# Retrieve an Inventory Source:", "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySource"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventorySource"}}}, "tags": ["api"]}, "delete": {"operationId": "api_inventory_sources_delete", "summary": "# Retrieve an Inventory Source:", "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/activity_stream/": {"get": {"operationId": "api_inventory_sources_activity_stream_list", "summary": "# List Activity Streams for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/credentials/": {"get": {"operationId": "api_inventory_sources_credentials_list", "summary": "# List Credentials for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_credentials_create", "summary": "# List Credentials for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/groups/": {"get": {"operationId": "api_inventory_sources_groups_list", "summary": "# List Groups for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "delete": {"operationId": "api_inventory_sources_groups_delete", "summary": "# List Groups for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/hosts/": {"get": {"operationId": "api_inventory_sources_hosts_list", "summary": "# List Hosts for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Host"}}}}}}, "tags": ["api"]}, "delete": {"operationId": "api_inventory_sources_hosts_delete", "summary": "# List Hosts for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/inventory_updates/": {"get": {"operationId": "api_inventory_sources_inventory_updates_list", "summary": "# List Inventory Updates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventoryUpdateList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/notification_templates_error/": {"get": {"operationId": "api_inventory_sources_notification_templates_error_list", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_notification_templates_error_create", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/notification_templates_started/": {"get": {"operationId": "api_inventory_sources_notification_templates_started_list", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_notification_templates_started_create", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/notification_templates_success/": {"get": {"operationId": "api_inventory_sources_notification_templates_success_list", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_notification_templates_success_create", "summary": "# List Notification Templates for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/schedules/": {"get": {"operationId": "api_inventory_sources_schedules_list", "summary": "# List Schedules for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_schedules_create", "summary": "# List Schedules for an Inventory Source:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_sources/{id}/update/": {"get": {"operationId": "api_inventory_sources_update_read", "summary": "# Update Inventory Source", "description": "Make a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:\n\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_sources_update_create", "summary": "# Update Inventory Source", "description": "Make a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:\n\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InventorySourceUpdate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/": {"get": {"operationId": "api_inventory_updates_list", "summary": "# List Inventory Updates:", "description": "Make a GET request to this resource to retrieve the list of\ninventory updates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventoryUpdateList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/": {"get": {"operationId": "api_inventory_updates_read", "summary": "# Retrieve an Inventory Update:", "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n* `source_project`: The project used for this job. (field)\n\n\n\n\n\n# Delete an Inventory Update:\n\nMake a DELETE request to this resource to delete this inventory update.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryUpdateDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_inventory_updates_delete", "summary": "# Retrieve an Inventory Update:", "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n* `source_project`: The project used for this job. (field)\n\n\n\n\n\n# Delete an Inventory Update:\n\nMake a DELETE request to this resource to delete this inventory update.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/cancel/": {"get": {"operationId": "api_inventory_updates_cancel_read", "summary": "# Retrieve an Inventory Update:", "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InventoryUpdateCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_inventory_updates_cancel_create", "summary": "# Retrieve an Inventory Update:", "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InventoryUpdateCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InventoryUpdateCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/credentials/": {"get": {"operationId": "api_inventory_updates_credentials_list", "summary": "# List Credentials for an Inventory Update:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/events/": {"get": {"operationId": "api_inventory_updates_events_list", "summary": "# List Inventory Update Events for an Inventory Update:", "description": "Make a GET request to this resource to retrieve a list of\ninventory update events associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory update events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update event records. \n\n## Results\n\nEach inventory update event data structure includes the following fields:\n\n* `id`: Database ID for this inventory update event. (integer)\n* `type`: Data type for this inventory update event. (choice)\n* `url`: URL for this inventory update event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update event was created. (datetime)\n* `modified`: Timestamp when this inventory update event was last modified. (datetime)\n* `event`: (field)\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (field)\n* `changed`: (field)\n* `uuid`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `inventory_update`: (id)\n\n\n\n## Sorting\n\nTo specify that inventory update events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventoryUpdateEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/notifications/": {"get": {"operationId": "api_inventory_updates_notifications_list", "summary": "# List Notifications for an Inventory Update:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/inventory_updates/{id}/stdout/": {"get": {"operationId": "api_inventory_updates_stdout_read", "summary": "# Retrieve Inventory Update Stdout:", "description": "Make GET request to this resource to retrieve the stdout from running this\ninventory update.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UnifiedJobStdout"}}}, "produces": ["text/plain", "text/plain", "application/json", "text/plain", "text/plain"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_events/{id}/": {"get": {"operationId": "api_job_events_read", "summary": "# Retrieve a Job Event:", "description": "Make GET request to this resource to retrieve a single job event\nrecord containing the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobEvent"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_events/{id}/children/": {"get": {"operationId": "api_job_events_children_list", "summary": "# List Job Events for a Job Event:", "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob event.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_host_summaries/{id}/": {"get": {"operationId": "api_job_host_summaries_read", "summary": "# Retrieve a Job Host Summary:", "description": "Make GET request to this resource to retrieve a single job host summary\nrecord containing the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobHostSummary"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/": {"get": {"operationId": "api_job_templates_list", "summary": "# List Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\njob templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_create", "summary": "# List Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\njob templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/": {"get": {"operationId": "api_job_templates_read", "summary": "# Retrieve a Job Template:", "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobTemplate"}}}, "tags": ["api"]}, "put": {"operationId": "api_job_templates_update", "summary": "# Retrieve a Job Template:", "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobTemplate"}}}, "tags": ["api"]}, "patch": {"operationId": "api_job_templates_partial_update", "summary": "# Retrieve a Job Template:", "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobTemplate"}}}, "tags": ["api"]}, "delete": {"operationId": "api_job_templates_delete", "summary": "# Retrieve a Job Template:", "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/access_list/": {"get": {"operationId": "api_job_templates_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/activity_stream/": {"get": {"operationId": "api_job_templates_activity_stream_list", "summary": "# List Activity Streams for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/bitbucket_dc/": {"post": {"operationId": "api_job_templates_bitbucket_dc_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/callback/": {"get": {"operationId": "api_job_templates_callback_list", "summary": "The job template callback allows for ephemeral hosts to launch a new job.", "description": "Configure a host to POST to this resource, passing the `host_config_key`\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the `N` parameter with the `id` of the job template\nand the `HOST_CONFIG_KEY` with the `host_config_key` associated with the\njob template.\n\nFor example, using curl:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\n\nOr using wget:\n\n wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n\nYou may also pass `extra_vars` to the callback:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\n\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.\n\n_(New in Ansible Tower 2.0.0)_ If the associated inventory has the\n`update_on_launch` flag set and if the `update_cache_timeout` has expired, the\ncallback will perform an inventory sync to find a matching host.\n\nA GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:\n\n curl http://user:password@server/api/v2/job_templates/N/callback/\n\nThe response will include the host config key as well as the host name(s)\nthat would match the request:\n\n {\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n }", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_callback_create", "summary": "The job template callback allows for ephemeral hosts to launch a new job.", "description": "Configure a host to POST to this resource, passing the `host_config_key`\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the `N` parameter with the `id` of the job template\nand the `HOST_CONFIG_KEY` with the `host_config_key` associated with the\njob template.\n\nFor example, using curl:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\n\nOr using wget:\n\n wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n\nYou may also pass `extra_vars` to the callback:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\n\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.\n\n_(New in Ansible Tower 2.0.0)_ If the associated inventory has the\n`update_on_launch` flag set and if the `update_cache_timeout` has expired, the\ncallback will perform an inventory sync to find a matching host.\n\nA GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:\n\n curl http://user:password@server/api/v2/job_templates/N/callback/\n\nThe response will include the host config key as well as the host name(s)\nthat would match the request:\n\n {\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n }", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/copy/": {"get": {"operationId": "api_job_templates_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/credentials/": {"get": {"operationId": "api_job_templates_credentials_list", "summary": "# List Credentials for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_credentials_create", "summary": "# List Credentials for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/github/": {"post": {"operationId": "api_job_templates_github_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/gitlab/": {"post": {"operationId": "api_job_templates_gitlab_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/instance_groups/": {"get": {"operationId": "api_job_templates_instance_groups_list", "summary": "# List Instance Groups for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_instance_groups_create", "summary": "# List Instance Groups for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/jobs/": {"get": {"operationId": "api_job_templates_jobs_list", "summary": "# List Jobs for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\njobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job records. \n\n## Results\n\nEach job data structure includes the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n\n\n\n## Sorting\n\nTo specify that jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/labels/": {"get": {"operationId": "api_job_templates_labels_list", "summary": "# List Labels for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_labels_create", "summary": "# List Labels for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/launch/": {"get": {"operationId": "api_job_templates_launch_read", "summary": "Launch a Job Template:", "description": "Make a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:\n\n* `ask_variables_on_launch`: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)\n* `ask_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)\n* `ask_skip_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)\n* `ask_job_type_on_launch`: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)\n* `ask_limit_on_launch`: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)\n* `ask_inventory_on_launch`: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)\n* `ask_credential_on_launch`: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)\n* `can_start_without_user_input`: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)\n* `passwords_needed_to_start`: Password names required to launch the\n job_template (array, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)\n* `inventory_needed_to_start`: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)\n\nMake a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the `inventory_needed_to_start` is `True` then the\n`inventory` is required.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobLaunch"}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_launch_create", "summary": "Launch a Job Template:", "description": "Make a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:\n\n* `ask_variables_on_launch`: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)\n* `ask_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)\n* `ask_skip_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)\n* `ask_job_type_on_launch`: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)\n* `ask_limit_on_launch`: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)\n* `ask_inventory_on_launch`: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)\n* `ask_credential_on_launch`: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)\n* `can_start_without_user_input`: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)\n* `passwords_needed_to_start`: Password names required to launch the\n job_template (array, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)\n* `inventory_needed_to_start`: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)\n\nMake a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the `inventory_needed_to_start` is `True` then the\n`inventory` is required.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobLaunch"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobLaunch"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/notification_templates_error/": {"get": {"operationId": "api_job_templates_notification_templates_error_list", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_notification_templates_error_create", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/notification_templates_started/": {"get": {"operationId": "api_job_templates_notification_templates_started_list", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_notification_templates_started_create", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/notification_templates_success/": {"get": {"operationId": "api_job_templates_notification_templates_success_list", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_notification_templates_success_create", "summary": "# List Notification Templates for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/object_roles/": {"get": {"operationId": "api_job_templates_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Job Template:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/schedules/": {"get": {"operationId": "api_job_templates_schedules_list", "summary": "# List Schedules for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_schedules_create", "summary": "# List Schedules for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/slice_workflow_jobs/": {"get": {"operationId": "api_job_templates_slice_workflow_jobs_list", "summary": "# List Workflow Jobs for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_slice_workflow_jobs_create", "summary": "# List Workflow Jobs for a Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobList"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/survey_spec/": {"get": {"operationId": "api_job_templates_survey_spec_list", "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_survey_spec_create", "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "delete": {"operationId": "api_job_templates_survey_spec_delete", "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/job_templates/{id}/webhook_key/": {"get": {"operationId": "api_job_templates_webhook_key_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_job_templates_webhook_key_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/": {"get": {"operationId": "api_jobs_list", "summary": "# List Jobs:", "description": "Make a GET request to this resource to retrieve the list of\njobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job records. \n\n## Results\n\nEach job data structure includes the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n\n\n\n## Sorting\n\nTo specify that jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/": {"get": {"operationId": "api_jobs_read", "summary": "# Retrieve a Job:", "description": "Make GET request to this resource to retrieve a single job\nrecord containing the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n* `custom_virtualenv`: (string)\n\n\n\n\n\n# Delete a Job:\n\nMake a DELETE request to this resource to delete this job.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_jobs_delete", "summary": "# Retrieve a Job:", "description": "Make GET request to this resource to retrieve a single job\nrecord containing the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n* `custom_virtualenv`: (string)\n\n\n\n\n\n# Delete a Job:\n\nMake a DELETE request to this resource to delete this job.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/activity_stream/": {"get": {"operationId": "api_jobs_activity_stream_list", "summary": "# List Activity Streams for a Job:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/cancel/": {"get": {"operationId": "api_jobs_cancel_read", "summary": "# Determine if a Job can be canceled", "description": "Make a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:\n\n* `can_cancel`: Indicates whether this job can be canceled (boolean, read-only)\n\n\n\n# Cancel a Job\nMake a POST request to this resource to cancel a pending or running job. The\nresponse status code will be 202 if successful, or 405 if the job cannot be\ncanceled.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_jobs_cancel_create", "summary": "# Determine if a Job can be canceled", "description": "Make a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:\n\n* `can_cancel`: Indicates whether this job can be canceled (boolean, read-only)\n\n\n\n# Cancel a Job\nMake a POST request to this resource to cancel a pending or running job. The\nresponse status code will be 202 if successful, or 405 if the job cannot be\ncanceled.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/create_schedule/": {"get": {"operationId": "api_jobs_create_schedule_read", "summary": "Create a schedule based on a job:", "description": "Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as `extra_vars`, `inventory`, `limit`, etc.\n\nJobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.\n\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobCreateSchedule"}}}, "tags": ["api"]}, "post": {"operationId": "api_jobs_create_schedule_create", "summary": "Create a schedule based on a job:", "description": "Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as `extra_vars`, `inventory`, `limit`, etc.\n\nJobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.\n\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobCreateSchedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobCreateSchedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/credentials/": {"get": {"operationId": "api_jobs_credentials_list", "summary": "# List Credentials for a Job:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/job_events/": {"get": {"operationId": "api_jobs_job_events_list", "summary": "# List Job Events for a Job:", "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/job_events/children_summary/": {"get": {"operationId": "api_jobs_job_events_children_summary_list", "summary": "# View a summary of children events", "description": "Special view to facilitate processing job output in the UI.\nIn order to collapse events and their children, the UI needs to know how\nmany children exist for a given event.\nThe UI also needs to know the order of the event (0 based index), which\nusually matches the counter, but not always.\nThis view returns a JSON object where the key is the event counter, and the value\nincludes the number of children (and grandchildren) events.\nOnly events with children are included in the output.\n\n## Example\n\ne.g. Demo Job Template job\ntuple(event counter, uuid, parent_uuid)\n\n```\n(1, '4598d19e-93b4-4e33-a0ae-b387a7348964', '')\n(2, 'aae0d189-e3cb-102a-9f00-000000000006', '4598d19e-93b4-4e33-a0ae-b387a7348964')\n(3, 'aae0d189-e3cb-102a-9f00-00000000000c', 'aae0d189-e3cb-102a-9f00-000000000006')\n(4, 'f4194f14-e406-4124-8519-0fdb08b18f4b', 'aae0d189-e3cb-102a-9f00-00000000000c')\n(5, '39f7ad99-dbf3-41e0-93f8-9999db4004f2', 'aae0d189-e3cb-102a-9f00-00000000000c')\n(6, 'aae0d189-e3cb-102a-9f00-000000000008', 'aae0d189-e3cb-102a-9f00-000000000006')\n(7, '39a49992-5ca4-4b6c-b178-e56d0b0333da', 'aae0d189-e3cb-102a-9f00-000000000008')\n(8, '504f3b28-3ea8-4f6f-bd82-60cf8e807cc0', 'aae0d189-e3cb-102a-9f00-000000000008')\n(9, 'a242be54-ebe6-4021-afab-f2878bff2e9f', '4598d19e-93b4-4e33-a0ae-b387a7348964')\n```\n\noutput\n\n```\n{\n\"1\": {\n \"rowNumber\": 0,\n \"numChildren\": 8\n},\n\"2\": {\n \"rowNumber\": 1,\n \"numChildren\": 6\n},\n\"3\": {\n \"rowNumber\": 2,\n \"numChildren\": 2\n},\n\"6\": {\n \"rowNumber\": 5,\n \"numChildren\": 2\n}\n}\n\"meta_event_nested_parent_uuid\": {}\n}\n```\n\ncounter 1 is event 0, and has 8 children\ncounter 2 is event 1, and has 6 children\netc.\n\nThe UI also needs to be able to collapse over \"meta\" events -- events that\nshow up due to verbosity or warnings from the system while the play is running.\nThese events have a 0 level event, with no parent uuid.\n\n```\nplaybook_on_start\nverbose\n playbook_on_play_start\n playbook_on_task_start\n runner_on_start <- level 3\nverbose <- jump to level 0\nverbose\n runner_on_ok <- jump back to level 3\n playbook_on_task_start\n runner_on_start\n runner_on_ok\nverbose\nverbose\n playbook_on_stats\n```\n\nThese verbose statements that fall in the middle of a series of children events\nare problematic for the UI.\nTo help, this view will attempt to place the events into the hierarchy, without\nthe event level jumps.\n\n```\nplaybook_on_start\n verbose\n playbook_on_play_start\n playbook_on_task_start\n runner_on_start <- A\n verbose <- this maps to the uuid of A\n verbose\n runner_on_ok\n playbook_on_task_start <- B\n runner_on_start\n runner_on_ok\n verbose <- this maps to the uuid of B\n verbose\n playbook_on_stats\n```\n\nThe output will include a JSON object where the key is the event counter,\nand the value is the assigned nested uuid.", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/job_host_summaries/": {"get": {"operationId": "api_jobs_job_host_summaries_list", "summary": "# List Job Host Summaries for a Job:", "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobHostSummary"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/labels/": {"get": {"operationId": "api_jobs_labels_list", "summary": "# List Labels for a Job:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/notifications/": {"get": {"operationId": "api_jobs_notifications_list", "summary": "# List Notifications for a Job:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/relaunch/": {"get": {"operationId": "api_jobs_relaunch_read", "summary": "Relaunch a Job:", "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/JobRelaunch"}}}, "tags": ["api"]}, "post": {"operationId": "api_jobs_relaunch_create", "summary": "Relaunch a Job:", "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobRelaunch"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobRelaunch"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/jobs/{id}/stdout/": {"get": {"operationId": "api_jobs_stdout_read", "summary": "# Retrieve Job Stdout:", "description": "Make GET request to this resource to retrieve the stdout from running this\njob.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UnifiedJobStdout"}}}, "produces": ["text/plain", "text/plain", "application/json", "text/plain", "text/plain"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/labels/": {"get": {"operationId": "api_labels_list", "summary": "# List Labels:", "description": "Make a GET request to this resource to retrieve the list of\nlabels.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_labels_create", "summary": "# List Labels:", "description": "Make a GET request to this resource to retrieve the list of\nlabels.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/labels/{id}/": {"get": {"operationId": "api_labels_read", "summary": "# Retrieve a Label:", "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "put": {"operationId": "api_labels_update", "summary": "# Retrieve a Label:", "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "patch": {"operationId": "api_labels_partial_update", "summary": "# Retrieve a Label:", "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/me/": {"get": {"operationId": "api_me_list", "summary": "# Retrieve Information about the current User", "description": "Make a GET request to retrieve user information about the current user.\n\nOne result should be returned containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\nUse the primary URL for the user (/api/v2/users/N/) to modify the user.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/mesh_visualizer/": {"get": {"operationId": "api_mesh_visualizer_list", "description": "Make a GET request to this resource to obtain a list all Receptor Nodes and their links.", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/metrics/": {"get": {"operationId": "api_metrics_list", "description": "Show Metrics Details", "parameters": [], "responses": {"200": {"description": ""}}, "produces": ["text/plain", "application/json"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notification_templates/": {"get": {"operationId": "api_notification_templates_list", "summary": "# List Notification Templates:", "description": "Make a GET request to this resource to retrieve the list of\nnotification templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_notification_templates_create", "summary": "# List Notification Templates:", "description": "Make a GET request to this resource to retrieve the list of\nnotification templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notification_templates/{id}/": {"get": {"operationId": "api_notification_templates_read", "summary": "# Retrieve a Notification Template:", "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "put": {"operationId": "api_notification_templates_update", "summary": "# Retrieve a Notification Template:", "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "patch": {"operationId": "api_notification_templates_partial_update", "summary": "# Retrieve a Notification Template:", "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "delete": {"operationId": "api_notification_templates_delete", "summary": "# Retrieve a Notification Template:", "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notification_templates/{id}/copy/": {"get": {"operationId": "api_notification_templates_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_notification_templates_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notification_templates/{id}/notifications/": {"get": {"operationId": "api_notification_templates_notifications_list", "summary": "# List Notifications for a Notification Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nnotification template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notification_templates/{id}/test/": {"post": {"operationId": "api_notification_templates_test_create", "description": "Test a Notification Template", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notifications/": {"get": {"operationId": "api_notifications_list", "summary": "# List Notifications:", "description": "Make a GET request to this resource to retrieve the list of\nnotifications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/notifications/{id}/": {"get": {"operationId": "api_notifications_read", "summary": "# Retrieve a Notification:", "description": "Make GET request to this resource to retrieve a single notification\nrecord containing the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Notification"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/": {"get": {"operationId": "api_organizations_list", "summary": "# List Organizations:", "description": "Make a GET request to this resource to retrieve the list of\norganizations.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Organization"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_create", "summary": "# List Organizations:", "description": "Make a GET request to this resource to retrieve the list of\norganizations.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Organization"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Organization"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/": {"get": {"operationId": "api_organizations_read", "summary": "# Retrieve an Organization:", "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Organization"}}}, "tags": ["api"]}, "put": {"operationId": "api_organizations_update", "summary": "# Retrieve an Organization:", "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Organization"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Organization"}}}, "tags": ["api"]}, "patch": {"operationId": "api_organizations_partial_update", "summary": "# Retrieve an Organization:", "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Organization"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Organization"}}}, "tags": ["api"]}, "delete": {"operationId": "api_organizations_delete", "summary": "# Retrieve an Organization:", "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/access_list/": {"get": {"operationId": "api_organizations_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/activity_stream/": {"get": {"operationId": "api_organizations_activity_stream_list", "summary": "# List Activity Streams for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/admins/": {"get": {"operationId": "api_organizations_admins_list", "summary": "# List Admin Users for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of admin users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more admin user records. \n\n## Results\n\nEach admin user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that admin users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_admins_create", "summary": "# List Admin Users for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of admin users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more admin user records. \n\n## Results\n\nEach admin user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that admin users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/applications/": {"get": {"operationId": "api_organizations_applications_list", "summary": "# List Applications for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Application"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_applications_create", "summary": "# List Applications for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Application"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/credentials/": {"get": {"operationId": "api_organizations_credentials_list", "summary": "# List Credentials for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OrganizationCredentialSerializerCreate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_credentials_create", "summary": "# List Credentials for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OrganizationCredentialSerializerCreate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OrganizationCredentialSerializerCreate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/execution_environments/": {"get": {"operationId": "api_organizations_execution_environments_list", "summary": "# List Execution Environments for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nexecution environments associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ExecutionEnvironment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_execution_environments_create", "summary": "# List Execution Environments for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nexecution environments associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ExecutionEnvironment"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/galaxy_credentials/": {"get": {"operationId": "api_organizations_galaxy_credentials_list", "summary": "# List Credentials for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_galaxy_credentials_create", "summary": "# List Credentials for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/instance_groups/": {"get": {"operationId": "api_organizations_instance_groups_list", "summary": "# List Instance Groups for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_instance_groups_create", "summary": "# List Instance Groups for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/inventories/": {"get": {"operationId": "api_organizations_inventories_list", "summary": "# List Inventories for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Inventory"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/job_templates/": {"get": {"operationId": "api_organizations_job_templates_list", "summary": "# List Job Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/JobTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_job_templates_create", "summary": "# List Job Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/JobTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/JobTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/notification_templates/": {"get": {"operationId": "api_organizations_notification_templates_list", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_notification_templates_create", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/notification_templates_approvals/": {"get": {"operationId": "api_organizations_notification_templates_approvals_list", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_notification_templates_approvals_create", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/notification_templates_error/": {"get": {"operationId": "api_organizations_notification_templates_error_list", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_notification_templates_error_create", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/notification_templates_started/": {"get": {"operationId": "api_organizations_notification_templates_started_list", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_notification_templates_started_create", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/notification_templates_success/": {"get": {"operationId": "api_organizations_notification_templates_success_list", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_notification_templates_success_create", "summary": "# List Notification Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/object_roles/": {"get": {"operationId": "api_organizations_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for an Organization:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/projects/": {"get": {"operationId": "api_organizations_projects_list", "summary": "# List Projects for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_projects_create", "summary": "# List Projects for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/teams/": {"get": {"operationId": "api_organizations_teams_list", "summary": "# List Teams for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_teams_create", "summary": "# List Teams for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Team"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/users/": {"get": {"operationId": "api_organizations_users_list", "summary": "# List Users for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_users_create", "summary": "# List Users for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/organizations/{id}/workflow_job_templates/": {"get": {"operationId": "api_organizations_workflow_job_templates_list", "summary": "# List Workflow Job Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_organizations_workflow_job_templates_create", "summary": "# List Workflow Job Templates for an Organization:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/ping/": {"get": {"operationId": "api_ping_list", "summary": "Return some basic information about this instance", "description": "Everything returned here should be considered public / insecure, as\nthis requires no auth and is intended for use by the installer process.", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/": {"get": {"operationId": "api_project_updates_list", "summary": "# List Project Updates:", "description": "Make a GET request to this resource to retrieve the list of\nproject updates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update records. \n\n## Results\n\nEach project update data structure includes the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n\n\n\n## Sorting\n\nTo specify that project updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ProjectUpdateList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/": {"get": {"operationId": "api_project_updates_read", "summary": "# Retrieve a Project Update:", "description": "Make GET request to this resource to retrieve a single project update\nrecord containing the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n\n\n\n\n\n# Delete a Project Update:\n\nMake a DELETE request to this resource to delete this project update.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectUpdateDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_project_updates_delete", "summary": "# Retrieve a Project Update:", "description": "Make GET request to this resource to retrieve a single project update\nrecord containing the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n\n\n\n\n\n# Delete a Project Update:\n\nMake a DELETE request to this resource to delete this project update.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/cancel/": {"get": {"operationId": "api_project_updates_cancel_read", "summary": "# Cancel Project Update", "description": "Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this update can be canceled (boolean,\n read-only)\n\nMake a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectUpdateCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_project_updates_cancel_create", "summary": "# Cancel Project Update", "description": "Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this update can be canceled (boolean,\n read-only)\n\nMake a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUpdateCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ProjectUpdateCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/events/": {"get": {"operationId": "api_project_updates_events_list", "summary": "# List Project Update Events for a Project Update:", "description": "Make a GET request to this resource to retrieve a list of\nproject update events associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project update events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update event records. \n\n## Results\n\nEach project update event data structure includes the following fields:\n\n* `id`: Database ID for this project update event. (integer)\n* `type`: Data type for this project update event. (choice)\n* `url`: URL for this project update event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update event was created. (datetime)\n* `modified`: Timestamp when this project update event was last modified. (datetime)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host_name`: (field)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (field)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `project_update`: (id)\n\n\n\n## Sorting\n\nTo specify that project update events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ProjectUpdateEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/notifications/": {"get": {"operationId": "api_project_updates_notifications_list", "summary": "# List Notifications for a Project Update:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/scm_inventory_updates/": {"get": {"operationId": "api_project_updates_scm_inventory_updates_list", "summary": "# List Inventory Updates for a Project Update:", "description": "Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventoryUpdateList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/project_updates/{id}/stdout/": {"get": {"operationId": "api_project_updates_stdout_read", "summary": "# Retrieve Project Update Stdout:", "description": "Make GET request to this resource to retrieve the stdout from running this\nproject update.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UnifiedJobStdout"}}}, "produces": ["text/plain", "text/plain", "application/json", "text/plain", "text/plain"], "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/": {"get": {"operationId": "api_projects_list", "summary": "# List Projects:", "description": "Make a GET request to this resource to retrieve the list of\nprojects.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_create", "summary": "# List Projects:", "description": "Make a GET request to this resource to retrieve the list of\nprojects.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/": {"get": {"operationId": "api_projects_read", "summary": "# Retrieve a Project:", "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["api"]}, "put": {"operationId": "api_projects_update", "summary": "# Retrieve a Project:", "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["api"]}, "patch": {"operationId": "api_projects_partial_update", "summary": "# Retrieve a Project:", "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["api"]}, "delete": {"operationId": "api_projects_delete", "summary": "# Retrieve a Project:", "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/access_list/": {"get": {"operationId": "api_projects_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/activity_stream/": {"get": {"operationId": "api_projects_activity_stream_list", "summary": "# List Activity Streams for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/copy/": {"get": {"operationId": "api_projects_copy_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_copy_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/inventories/": {"get": {"operationId": "api_projects_inventories_read", "summary": "# Retrieve a Project:", "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `inventory_files`: Array of inventory files and directories available within this project, not comprehensive. (json)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectInventories"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/notification_templates_error/": {"get": {"operationId": "api_projects_notification_templates_error_list", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_notification_templates_error_create", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/notification_templates_started/": {"get": {"operationId": "api_projects_notification_templates_started_list", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_notification_templates_started_create", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/notification_templates_success/": {"get": {"operationId": "api_projects_notification_templates_success_list", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_notification_templates_success_create", "summary": "# List Notification Templates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/object_roles/": {"get": {"operationId": "api_projects_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Project:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/playbooks/": {"get": {"operationId": "api_projects_playbooks_read", "summary": "# Retrieve Project Playbooks:", "description": "Make GET request to this resource to retrieve a list of playbooks available\nfor a project.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectPlaybooks"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/project_updates/": {"get": {"operationId": "api_projects_project_updates_list", "summary": "# List Project Updates for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nproject updates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update records. \n\n## Results\n\nEach project update data structure includes the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n\n\n\n## Sorting\n\nTo specify that project updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ProjectUpdateList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/schedules/": {"get": {"operationId": "api_projects_schedules_list", "summary": "# List Schedules for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_schedules_create", "summary": "# List Schedules for a Project:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/scm_inventory_sources/": {"get": {"operationId": "api_projects_scm_inventory_sources_list", "summary": "# List Inventory Sources for a Project:", "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InventorySource"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/teams/": {"get": {"operationId": "api_projects_teams_list", "summary": "# List Teams:", "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/projects/{id}/update/": {"get": {"operationId": "api_projects_update_read", "summary": "# Update Project", "description": "Make a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:\n\n* `can_update`: Flag indicating if this project can be updated (boolean,\n read-only)\n\nMake a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectUpdateView"}}}, "tags": ["api"]}, "post": {"operationId": "api_projects_update_create", "summary": "# Update Project", "description": "Make a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:\n\n* `can_update`: Flag indicating if this project can be updated (boolean,\n read-only)\n\nMake a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUpdateView"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ProjectUpdateView"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/receptor_addresses/": {"get": {"operationId": "api_receptor_addresses_list", "summary": "# List Receptor Addresss:", "description": "Make a GET request to this resource to retrieve the list of\nreceptor addresss.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ReceptorAddress"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/receptor_addresses/{id}/": {"get": {"operationId": "api_receptor_addresses_read", "summary": "# Retrieve a Receptor Address:", "description": "Make GET request to this resource to retrieve a single receptor address\nrecord containing the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ReceptorAddress"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/": {"get": {"operationId": "api_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles:\n\nMake a GET request to this resource to retrieve the list of\nroles.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/{id}/": {"get": {"operationId": "api_roles_read", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# Retrieve a Role:\n\nMake GET request to this resource to retrieve a single role\nrecord containing the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Role"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/{id}/children/": {"get": {"operationId": "api_roles_children_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Role:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/{id}/parents/": {"get": {"operationId": "api_roles_parents_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Role:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/{id}/teams/": {"get": {"operationId": "api_roles_teams_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Teams for a Role:\n\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_roles_teams_create", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Teams for a Role:\n\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Team"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/roles/{id}/users/": {"get": {"operationId": "api_roles_users_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users for a Role:\n\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_roles_users_create", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users for a Role:\n\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/": {"get": {"operationId": "api_schedules_list", "summary": "# List Schedules:", "description": "Make a GET request to this resource to retrieve the list of\nschedules.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_schedules_create", "summary": "# List Schedules:", "description": "Make a GET request to this resource to retrieve the list of\nschedules.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/preview/": {"post": {"operationId": "api_schedules_preview_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SchedulePreview"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SchedulePreview"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/zoneinfo/": {"get": {"operationId": "api_schedules_zoneinfo_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/{id}/": {"get": {"operationId": "api_schedules_read", "summary": "# Retrieve a Schedule:", "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "put": {"operationId": "api_schedules_update", "summary": "# Retrieve a Schedule:", "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "patch": {"operationId": "api_schedules_partial_update", "summary": "# Retrieve a Schedule:", "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "delete": {"operationId": "api_schedules_delete", "summary": "# Retrieve a Schedule:", "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/{id}/credentials/": {"get": {"operationId": "api_schedules_credentials_list", "summary": "# List Credentials for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_schedules_credentials_create", "summary": "# List Credentials for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/{id}/instance_groups/": {"get": {"operationId": "api_schedules_instance_groups_list", "summary": "# List Instance Groups for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_schedules_instance_groups_create", "summary": "# List Instance Groups for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/{id}/jobs/": {"get": {"operationId": "api_schedules_jobs_list", "summary": "# List Unified Jobs for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/schedules/{id}/labels/": {"get": {"operationId": "api_schedules_labels_list", "summary": "# List Labels for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_schedules_labels_create", "summary": "# List Labels for a Schedule:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/settings/": {"get": {"operationId": "api_settings_list", "summary": "# List Settings:", "description": "Make a GET request to this resource to retrieve the list of\nsettings.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of settings\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more setting records. \n\n## Results\n\nEach setting data structure includes the following fields:\n\n* `url`: (string)\n* `slug`: (string)\n* `name`: (string)\n\n\n\n## Sorting\n\nTo specify that settings are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SettingCategory"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/settings/logging/test/": {"post": {"operationId": "api_settings_logging_test_create", "description": "# Test Logging Configuration", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SettingSingleton"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SettingSingleton"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/settings/{category_slug}/": {"get": {"operationId": "api_settings_read", "summary": "# Retrieve a Setting:", "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `UI_NEXT`: Enable preview of new user interface. (boolean)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `UI_NEXT`: Enable preview of new user interface. (boolean, default=`True`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SettingSingleton"}}}, "tags": ["api"]}, "put": {"operationId": "api_settings_update", "summary": "# Retrieve a Setting:", "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `UI_NEXT`: Enable preview of new user interface. (boolean)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `UI_NEXT`: Enable preview of new user interface. (boolean, default=`True`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SettingSingleton"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SettingSingleton"}}}, "tags": ["api"]}, "patch": {"operationId": "api_settings_partial_update", "summary": "# Retrieve a Setting:", "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `UI_NEXT`: Enable preview of new user interface. (boolean)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `UI_NEXT`: Enable preview of new user interface. (boolean, default=`True`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SettingSingleton"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SettingSingleton"}}}, "tags": ["api"]}, "delete": {"operationId": "api_settings_delete", "summary": "# Retrieve a Setting:", "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `UI_NEXT`: Enable preview of new user interface. (boolean)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `UI_NEXT`: Enable preview of new user interface. (boolean, default=`True`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "category_slug", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/": {"get": {"operationId": "api_system_job_templates_list", "summary": "# List System Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\nsystem job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job template records. \n\n## Results\n\nEach system job template data structure includes the following fields:\n\n* `id`: Database ID for this system job template. (integer)\n* `type`: Data type for this system job template. (choice)\n* `url`: URL for this system job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job template was created. (datetime)\n* `modified`: Timestamp when this system job template was last modified. (datetime)\n* `name`: Name of this system job template. (string)\n* `description`: Optional description of this system job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n\n\n\n## Sorting\n\nTo specify that system job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SystemJobTemplate"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/": {"get": {"operationId": "api_system_job_templates_read", "summary": "# Retrieve a System Job Template:", "description": "Make GET request to this resource to retrieve a single system job template\nrecord containing the following fields:\n\n* `id`: Database ID for this system job template. (integer)\n* `type`: Data type for this system job template. (choice)\n* `url`: URL for this system job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job template was created. (datetime)\n* `modified`: Timestamp when this system job template was last modified. (datetime)\n* `name`: Name of this system job template. (string)\n* `description`: Optional description of this system job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SystemJobTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/jobs/": {"get": {"operationId": "api_system_job_templates_jobs_list", "summary": "# List System Jobs for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nsystem jobs associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job records. \n\n## Results\n\nEach system job data structure includes the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n## Sorting\n\nTo specify that system jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SystemJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/launch/": {"get": {"operationId": "api_system_job_templates_launch_list", "summary": "Launch a Job Template:", "description": "Make a POST request to this resource to launch the system job template.\n\nVariables specified inside of the parameter `extra_vars` are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the `awx-manage` command.\n\nFor example on `cleanup_jobs` and `cleanup_activitystream`:\n\n`{\"extra_vars\": {\"days\": 30}}`\n\nWhich will act on data older than 30 days.\n\nFor `cleanup_activitystream` and `cleanup_jobs` commands, providing\n`\"dry_run\": true` inside of `extra_vars` will show items that will be\nremoved without deleting them.\n\nEach individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty `extra_vars`.\n\n - Defaults for `cleanup_activitystream`: days=90\n - Defaults for `cleanup_jobs`: days=90\n\nIf successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_system_job_templates_launch_create", "summary": "Launch a Job Template:", "description": "Make a POST request to this resource to launch the system job template.\n\nVariables specified inside of the parameter `extra_vars` are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the `awx-manage` command.\n\nFor example on `cleanup_jobs` and `cleanup_activitystream`:\n\n`{\"extra_vars\": {\"days\": 30}}`\n\nWhich will act on data older than 30 days.\n\nFor `cleanup_activitystream` and `cleanup_jobs` commands, providing\n`\"dry_run\": true` inside of `extra_vars` will show items that will be\nremoved without deleting them.\n\nEach individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty `extra_vars`.\n\n - Defaults for `cleanup_activitystream`: days=90\n - Defaults for `cleanup_jobs`: days=90\n\nIf successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/notification_templates_error/": {"get": {"operationId": "api_system_job_templates_notification_templates_error_list", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_system_job_templates_notification_templates_error_create", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/notification_templates_started/": {"get": {"operationId": "api_system_job_templates_notification_templates_started_list", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_system_job_templates_notification_templates_started_create", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/notification_templates_success/": {"get": {"operationId": "api_system_job_templates_notification_templates_success_list", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_system_job_templates_notification_templates_success_create", "summary": "# List Notification Templates for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_job_templates/{id}/schedules/": {"get": {"operationId": "api_system_job_templates_schedules_list", "summary": "# List Schedules for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_system_job_templates_schedules_create", "summary": "# List Schedules for a System Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_jobs/": {"get": {"operationId": "api_system_jobs_list", "summary": "# List System Jobs:", "description": "Make a GET request to this resource to retrieve the list of\nsystem jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job records. \n\n## Results\n\nEach system job data structure includes the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n## Sorting\n\nTo specify that system jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SystemJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_jobs/{id}/": {"get": {"operationId": "api_system_jobs_read", "summary": "# Retrieve a System Job:", "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n\n\n# Delete a System Job:\n\nMake a DELETE request to this resource to delete this system job.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SystemJob"}}}, "tags": ["api"]}, "delete": {"operationId": "api_system_jobs_delete", "summary": "# Retrieve a System Job:", "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n\n\n# Delete a System Job:\n\nMake a DELETE request to this resource to delete this system job.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_jobs/{id}/cancel/": {"get": {"operationId": "api_system_jobs_cancel_read", "summary": "# Retrieve a System Job:", "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SystemJobCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_system_jobs_cancel_create", "summary": "# Retrieve a System Job:", "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SystemJobCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SystemJobCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_jobs/{id}/events/": {"get": {"operationId": "api_system_jobs_events_list", "summary": "# List System Job Events for a System Job:", "description": "Make a GET request to this resource to retrieve a list of\nsystem job events associated with the selected\nsystem job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job event records. \n\n## Results\n\nEach system job event data structure includes the following fields:\n\n* `id`: Database ID for this system job event. (integer)\n* `type`: Data type for this system job event. (choice)\n* `url`: URL for this system job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job event was created. (datetime)\n* `modified`: Timestamp when this system job event was last modified. (datetime)\n* `event`: (field)\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (field)\n* `changed`: (field)\n* `uuid`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `system_job`: (id)\n\n\n\n## Sorting\n\nTo specify that system job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SystemJobEvent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/system_jobs/{id}/notifications/": {"get": {"operationId": "api_system_jobs_notifications_list", "summary": "# List Notifications for a System Job:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nsystem job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/": {"get": {"operationId": "api_teams_list", "summary": "# List Teams:", "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_teams_create", "summary": "# List Teams:", "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Team"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/": {"get": {"operationId": "api_teams_read", "summary": "# Retrieve a Team:", "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "put": {"operationId": "api_teams_update", "summary": "# Retrieve a Team:", "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Team"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "patch": {"operationId": "api_teams_partial_update", "summary": "# Retrieve a Team:", "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Team"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Team"}}}, "tags": ["api"]}, "delete": {"operationId": "api_teams_delete", "summary": "# Retrieve a Team:", "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/access_list/": {"get": {"operationId": "api_teams_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/activity_stream/": {"get": {"operationId": "api_teams_activity_stream_list", "summary": "# List Activity Streams for a Team:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/credentials/": {"get": {"operationId": "api_teams_credentials_list", "summary": "# List Credentials for a Team:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TeamCredentialSerializerCreate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_teams_credentials_create", "summary": "# List Credentials for a Team:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TeamCredentialSerializerCreate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/TeamCredentialSerializerCreate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/object_roles/": {"get": {"operationId": "api_teams_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/projects/": {"get": {"operationId": "api_teams_projects_list", "summary": "# List Projects for a Team:", "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/roles/": {"get": {"operationId": "api_teams_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected team.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_teams_roles_create", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected team.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/teams/{id}/users/": {"get": {"operationId": "api_teams_users_list", "summary": "# List Users for a Team:", "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_teams_users_create", "summary": "# List Users for a Team:", "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/tokens/": {"get": {"operationId": "api_tokens_list", "summary": "# List Access Tokens:", "description": "Make a GET request to this resource to retrieve the list of\naccess tokens.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Token"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_tokens_create", "summary": "# List Access Tokens:", "description": "Make a GET request to this resource to retrieve the list of\naccess tokens.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Token"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Token"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/tokens/{id}/": {"get": {"operationId": "api_tokens_read", "summary": "# Retrieve an Access Token:", "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2TokenDetail"}}}, "tags": ["api"]}, "put": {"operationId": "api_tokens_update", "summary": "# Retrieve an Access Token:", "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2TokenDetail"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2TokenDetail"}}}, "tags": ["api"]}, "patch": {"operationId": "api_tokens_partial_update", "summary": "# Retrieve an Access Token:", "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2TokenDetail"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OAuth2TokenDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_tokens_delete", "summary": "# Retrieve an Access Token:", "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/tokens/{id}/activity_stream/": {"get": {"operationId": "api_tokens_activity_stream_list", "summary": "# List Activity Streams for an Access Token:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\naccess token.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/unified_job_templates/": {"get": {"operationId": "api_unified_job_templates_list", "summary": "# List Unified Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\nunified job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job template records. \n\n## Results\n\nEach unified job template data structure includes the following fields:\n\n* `id`: Database ID for this unified job template. (integer)\n* `type`: Data type for this unified job template. (choice)\n* `url`: URL for this unified job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job template was created. (datetime)\n* `modified`: Timestamp when this unified job template was last modified. (datetime)\n* `name`: Name of this unified job template. (string)\n* `description`: Optional description of this unified job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n\n\n\n## Sorting\n\nTo specify that unified job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobTemplate"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/unified_jobs/": {"get": {"operationId": "api_unified_jobs_list", "summary": "# List Unified Jobs:", "description": "Make a GET request to this resource to retrieve the list of\nunified jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UnifiedJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/": {"get": {"operationId": "api_users_list", "summary": "# List Users:", "description": "Make a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_create", "summary": "# List Users:", "description": "Make a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/": {"get": {"operationId": "api_users_read", "summary": "# Retrieve a User:", "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "put": {"operationId": "api_users_update", "summary": "# Retrieve a User:", "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "patch": {"operationId": "api_users_partial_update", "summary": "# Retrieve a User:", "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["api"]}, "delete": {"operationId": "api_users_delete", "summary": "# Retrieve a User:", "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/access_list/": {"get": {"operationId": "api_users_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/activity_stream/": {"get": {"operationId": "api_users_activity_stream_list", "summary": "# List Activity Streams for a User:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/admin_of_organizations/": {"get": {"operationId": "api_users_admin_of_organizations_list", "summary": "# List Organizations Administered by this User:", "description": "Make a GET request to this resource to retrieve a list of\norganizations of which the selected\nuser is an admin.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Organization"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/applications/": {"get": {"operationId": "api_users_applications_list", "summary": "# List Applications:", "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Application"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_applications_create", "summary": "# List Applications:", "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Application"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Application"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/authorized_tokens/": {"get": {"operationId": "api_users_authorized_tokens_list", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UserAuthorizedToken"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_authorized_tokens_create", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserAuthorizedToken"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/UserAuthorizedToken"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/credentials/": {"get": {"operationId": "api_users_credentials_list", "summary": "# List Credentials for a User:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UserCredentialSerializerCreate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_credentials_create", "summary": "# List Credentials for a User:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserCredentialSerializerCreate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/UserCredentialSerializerCreate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/organizations/": {"get": {"operationId": "api_users_organizations_list", "summary": "# List Organizations for a User:", "description": "Make a GET request to this resource to retrieve a list of\norganizations associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Organization"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/personal_tokens/": {"get": {"operationId": "api_users_personal_tokens_list", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UserPersonalToken"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_personal_tokens_create", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserPersonalToken"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/UserPersonalToken"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/projects/": {"get": {"operationId": "api_users_projects_list", "summary": "# List Projects for a User:", "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/roles/": {"get": {"operationId": "api_users_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a User:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected user.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_roles_create", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a User:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected user.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RoleSerializerWithParentAccess"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/teams/": {"get": {"operationId": "api_users_teams_list", "summary": "# List Teams for a User:", "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Team"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/users/{id}/tokens/": {"get": {"operationId": "api_users_tokens_list", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OAuth2Token"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_users_tokens_create", "summary": "# List Access Tokens for a User:", "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OAuth2Token"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OAuth2Token"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approval_templates/{id}/": {"get": {"operationId": "api_workflow_approval_templates_read", "summary": "# Retrieve a Workflow Approval Template:", "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalTemplate"}}}, "tags": ["api"]}, "put": {"operationId": "api_workflow_approval_templates_update", "summary": "# Retrieve a Workflow Approval Template:", "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowApprovalTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalTemplate"}}}, "tags": ["api"]}, "patch": {"operationId": "api_workflow_approval_templates_partial_update", "summary": "# Retrieve a Workflow Approval Template:", "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowApprovalTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalTemplate"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_approval_templates_delete", "summary": "# Retrieve a Workflow Approval Template:", "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approval_templates/{id}/approvals/": {"get": {"operationId": "api_workflow_approval_templates_approvals_list", "summary": "# List Workflow Approvals for a Workflow Approval Template:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow approvals associated with the selected\nworkflow approval template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow approvals\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow approval records. \n\n## Results\n\nEach workflow approval data structure includes the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n## Sorting\n\nTo specify that workflow approvals are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowApprovalList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approvals/": {"get": {"operationId": "api_workflow_approvals_list", "summary": "# List Workflow Approvals:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow approvals.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow approvals\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow approval records. \n\n## Results\n\nEach workflow approval data structure includes the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n## Sorting\n\nTo specify that workflow approvals are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowApprovalList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approvals/{id}/": {"get": {"operationId": "api_workflow_approvals_read", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n\n\n# Delete a Workflow Approval:\n\nMake a DELETE request to this resource to delete this workflow approval.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApproval"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_approvals_delete", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n\n\n# Delete a Workflow Approval:\n\nMake a DELETE request to this resource to delete this workflow approval.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approvals/{id}/approve/": {"get": {"operationId": "api_workflow_approvals_approve_read", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_approvals_approve_create", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_approvals/{id}/deny/": {"get": {"operationId": "api_workflow_approvals_deny_read", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_approvals_deny_create", "summary": "# Retrieve a Workflow Approval:", "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowApprovalView"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/": {"get": {"operationId": "api_workflow_job_nodes_list", "summary": "# List Workflow Job Nodes:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow job nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobNodeList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/": {"get": {"operationId": "api_workflow_job_nodes_read", "summary": "# Retrieve a Workflow Job Node:", "description": "Make GET request to this resource to retrieve a single workflow job node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobNodeDetail"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/always_nodes/": {"get": {"operationId": "api_workflow_job_nodes_always_nodes_list", "summary": "# List Workflow Job Nodes for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobNodeList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/credentials/": {"get": {"operationId": "api_workflow_job_nodes_credentials_list", "summary": "# List Credentials for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/failure_nodes/": {"get": {"operationId": "api_workflow_job_nodes_failure_nodes_list", "summary": "# List Workflow Job Nodes for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobNodeList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/instance_groups/": {"get": {"operationId": "api_workflow_job_nodes_instance_groups_list", "summary": "# List Instance Groups for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_nodes_instance_groups_create", "summary": "# List Instance Groups for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/labels/": {"get": {"operationId": "api_workflow_job_nodes_labels_list", "summary": "# List Labels for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_nodes/{id}/success_nodes/": {"get": {"operationId": "api_workflow_job_nodes_success_nodes_list", "summary": "# List Workflow Job Nodes for a Workflow Job Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobNodeList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/": {"get": {"operationId": "api_workflow_job_template_nodes_list", "summary": "# List Workflow Job Template Nodes:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow job template nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_create", "summary": "# List Workflow Job Template Nodes:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow job template nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/": {"get": {"operationId": "api_workflow_job_template_nodes_read", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeDetail"}}}, "tags": ["api"]}, "put": {"operationId": "api_workflow_job_template_nodes_update", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeDetail"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeDetail"}}}, "tags": ["api"]}, "patch": {"operationId": "api_workflow_job_template_nodes_partial_update", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeDetail"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeDetail"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_job_template_nodes_delete", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/always_nodes/": {"get": {"operationId": "api_workflow_job_template_nodes_always_nodes_list", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_always_nodes_create", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/create_approval_template/": {"get": {"operationId": "api_workflow_job_template_nodes_create_approval_template_read", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval"}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_create_approval_template_create", "summary": "# Retrieve a Workflow Job Template Node:", "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/credentials/": {"get": {"operationId": "api_workflow_job_template_nodes_credentials_list", "summary": "# List Credentials for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_credentials_create", "summary": "# List Credentials for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Credential"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Credential"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/failure_nodes/": {"get": {"operationId": "api_workflow_job_template_nodes_failure_nodes_list", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_failure_nodes_create", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/instance_groups/": {"get": {"operationId": "api_workflow_job_template_nodes_instance_groups_list", "summary": "# List Instance Groups for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InstanceGroup"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_instance_groups_create", "summary": "# List Instance Groups for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InstanceGroup"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InstanceGroup"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/labels/": {"get": {"operationId": "api_workflow_job_template_nodes_labels_list", "summary": "# List Labels for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_labels_create", "summary": "# List Labels for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_template_nodes/{id}/success_nodes/": {"get": {"operationId": "api_workflow_job_template_nodes_success_nodes_list", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_template_nodes_success_nodes_create", "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/": {"get": {"operationId": "api_workflow_job_templates_list", "summary": "# List Workflow Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_create", "summary": "# List Workflow Job Templates:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/": {"get": {"operationId": "api_workflow_job_templates_read", "summary": "# Retrieve a Workflow Job Template:", "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}}, "tags": ["api"]}, "put": {"operationId": "api_workflow_job_templates_update", "summary": "# Retrieve a Workflow Job Template:", "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}}, "tags": ["api"]}, "patch": {"operationId": "api_workflow_job_templates_partial_update", "summary": "# Retrieve a Workflow Job Template:", "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplate"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_job_templates_delete", "summary": "# Retrieve a Workflow Job Template:", "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/access_list/": {"get": {"operationId": "api_workflow_job_templates_access_list_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ResourceAccessListElement"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/activity_stream/": {"get": {"operationId": "api_workflow_job_templates_activity_stream_list", "summary": "# List Activity Streams for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/bitbucket_dc/": {"post": {"operationId": "api_workflow_job_templates_bitbucket_dc_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/copy/": {"get": {"operationId": "api_workflow_job_templates_copy_list", "summary": "Copy a Workflow Job Template:", "description": "Make a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:\n\n* `can_copy`: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)\n* `can_copy_without_user_input`: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)\n* `templates_unable_to_copy`: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `inventories_unable_to_copy`: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `credentials_unable_to_copy`: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n\nMake a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional `@`\nand a timestamp in the name.\n\nAll workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Copy"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_copy_create", "summary": "Copy a Workflow Job Template:", "description": "Make a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:\n\n* `can_copy`: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)\n* `can_copy_without_user_input`: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)\n* `templates_unable_to_copy`: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `inventories_unable_to_copy`: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `credentials_unable_to_copy`: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n\nMake a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional `@`\nand a timestamp in the name.\n\nAll workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Copy"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Copy"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/github/": {"post": {"operationId": "api_workflow_job_templates_github_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/gitlab/": {"post": {"operationId": "api_workflow_job_templates_gitlab_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/labels/": {"get": {"operationId": "api_workflow_job_templates_labels_list", "summary": "# List Labels for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_labels_create", "summary": "# List Labels for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Label"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Label"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/launch/": {"get": {"operationId": "api_workflow_job_templates_launch_read", "summary": "Launch a Workflow Job Template:", "description": "Make a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:\n\n* `can_start_without_user_input`: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n workflow_job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)\n* `extra_vars`: Text which is the `extra_vars` field of this workflow_job_template\n (text, read-only)\n* `node_templates_missing`: List of node ids of all nodes that have a\n null `unified_job_template`, which will cause their branches to stop\n execution (list, read-only)\n* `node_prompts_rejected`: List of node ids of all nodes that have\n specified a field that will be rejected because its `unified_job_template`\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)\n* `workflow_job_template_data`: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)\n\nMake a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobLaunch"}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_launch_create", "summary": "Launch a Workflow Job Template:", "description": "Make a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:\n\n* `can_start_without_user_input`: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n workflow_job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)\n* `extra_vars`: Text which is the `extra_vars` field of this workflow_job_template\n (text, read-only)\n* `node_templates_missing`: List of node ids of all nodes that have a\n null `unified_job_template`, which will cause their branches to stop\n execution (list, read-only)\n* `node_prompts_rejected`: List of node ids of all nodes that have\n specified a field that will be rejected because its `unified_job_template`\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)\n* `workflow_job_template_data`: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)\n\nMake a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobLaunch"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobLaunch"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/notification_templates_approvals/": {"get": {"operationId": "api_workflow_job_templates_notification_templates_approvals_list", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_notification_templates_approvals_create", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/notification_templates_error/": {"get": {"operationId": "api_workflow_job_templates_notification_templates_error_list", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_notification_templates_error_create", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/notification_templates_started/": {"get": {"operationId": "api_workflow_job_templates_notification_templates_started_list", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_notification_templates_started_create", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/notification_templates_success/": {"get": {"operationId": "api_workflow_job_templates_notification_templates_success_list", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/NotificationTemplate"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_notification_templates_success_create", "summary": "# List Notification Templates for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/NotificationTemplate"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/NotificationTemplate"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/object_roles/": {"get": {"operationId": "api_workflow_job_templates_object_roles_list", "summary": "> _This resource has been deprecated and will be removed in a future release_", "description": "# List Roles for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/schedules/": {"get": {"operationId": "api_workflow_job_templates_schedules_list", "summary": "# List Schedules for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Schedule"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_schedules_create", "summary": "# List Schedules for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Schedule"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Schedule"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/survey_spec/": {"get": {"operationId": "api_workflow_job_templates_survey_spec_list", "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_survey_spec_create", "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_job_templates_survey_spec_delete", "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/webhook_key/": {"get": {"operationId": "api_workflow_job_templates_webhook_key_list", "description": "", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_webhook_key_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/workflow_jobs/": {"get": {"operationId": "api_workflow_job_templates_workflow_jobs_list", "summary": "# List Workflow Jobs for a Workflow Job Template:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_job_templates/{id}/workflow_nodes/": {"get": {"operationId": "api_workflow_job_templates_workflow_nodes_list", "summary": "# Workflow Job Template Workflow Node List", "description": "Workflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:\n\n - run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed\n - run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded\n\nThe workflow job is marked as `successful` if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.\n\n\n# List Workflow Job Template Nodes for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_job_templates_workflow_nodes_create", "summary": "# Workflow Job Template Workflow Node List", "description": "Workflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:\n\n - run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed\n - run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded\n\nThe workflow job is marked as `successful` if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.\n\n\n# List Workflow Job Template Nodes for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobTemplateNode"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/": {"get": {"operationId": "api_workflow_jobs_list", "summary": "# List Workflow Jobs:", "description": "Make a GET request to this resource to retrieve the list of\nworkflow jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/": {"get": {"operationId": "api_workflow_jobs_read", "summary": "# Retrieve a Workflow Job:", "description": "Make GET request to this resource to retrieve a single workflow job\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Delete a Workflow Job:\n\nMake a DELETE request to this resource to delete this workflow job.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJob"}}}, "tags": ["api"]}, "delete": {"operationId": "api_workflow_jobs_delete", "summary": "# Retrieve a Workflow Job:", "description": "Make GET request to this resource to retrieve a single workflow job\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Delete a Workflow Job:\n\nMake a DELETE request to this resource to delete this workflow job.", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/activity_stream/": {"get": {"operationId": "api_workflow_jobs_activity_stream_list", "summary": "# List Activity Streams for a Workflow Job:", "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityStream"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/cancel/": {"get": {"operationId": "api_workflow_jobs_cancel_read", "summary": "# Cancel Workflow Job", "description": "Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)\n\nMake a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobCancel"}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_jobs_cancel_create", "summary": "# Cancel Workflow Job", "description": "Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)\n\nMake a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowJobCancel"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowJobCancel"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/labels/": {"get": {"operationId": "api_workflow_jobs_labels_list", "summary": "# List Labels for a Workflow Job:", "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Label"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/notifications/": {"get": {"operationId": "api_workflow_jobs_notifications_list", "summary": "# List Notifications for a Workflow Job:", "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notification"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/relaunch/": {"get": {"operationId": "api_workflow_jobs_relaunch_list", "summary": "Relaunch a workflow job:", "description": "Make a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Empty"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_workflow_jobs_relaunch_create", "summary": "Relaunch a workflow job:", "description": "Make a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Empty"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Empty"}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/{version}/workflow_jobs/{id}/workflow_nodes/": {"get": {"operationId": "api_workflow_jobs_workflow_nodes_list", "summary": "# List Workflow Job Nodes for a Workflow Job:", "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", "parameters": [{"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowJobNodeList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "version", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}}, "definitions": {"RoleDefinition": {"required": ["permissions", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "permissions": {"type": "array", "items": {"type": "string", "enum": ["awx.add_credential", "awx.add_executionenvironment", "awx.add_inventory", "awx.add_notificationtemplate", "awx.add_project", "awx.add_workflowjobtemplate", "awx.adhoc_inventory", "awx.approve_workflowjobtemplate", "awx.change_credential", "awx.change_executionenvironment", "awx.change_instancegroup", "awx.change_inventory", "awx.change_jobtemplate", "awx.change_notificationtemplate", "awx.change_project", "awx.change_workflowjobtemplate", "awx.delete_credential", "awx.delete_executionenvironment", "awx.delete_instancegroup", "awx.delete_inventory", "awx.delete_jobtemplate", "awx.delete_notificationtemplate", "awx.delete_project", "awx.delete_workflowjobtemplate", "awx.execute_jobtemplate", "awx.execute_workflowjobtemplate", "awx.update_inventory", "awx.update_project", "awx.use_credential", "awx.use_instancegroup", "awx.use_inventory", "awx.use_project", "awx.view_credential", "awx.view_instancegroup", "awx.view_inventory", "awx.view_jobtemplate", "awx.view_notificationtemplate", "awx.view_project", "awx.view_workflowjobtemplate", "shared.add_team", "shared.audit_organization", "shared.change_organization", "shared.change_team", "shared.delete_organization", "shared.delete_team", "shared.member_organization", "shared.member_team", "shared.view_organization", "shared.view_team"]}}, "content_type": {"title": "Content type", "description": "The type of resource this applies to", "type": "string", "enum": ["awx.credential", "awx.executionenvironment", "awx.instancegroup", "awx.inventory", "awx.jobtemplate", "awx.notificationtemplate", "awx.project", "awx.workflowjobtemplate", "shared.organization", "shared.team"], "x-nullable": true}, "modified": {"title": "Modified", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "created": {"title": "Created", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "name": {"title": "Name", "type": "string", "minLength": 1}, "description": {"title": "Description", "type": "string"}, "managed": {"title": "Managed", "type": "boolean", "readOnly": true}, "modified_by": {"title": "Modified by", "description": "The user who last modified this resource", "type": "integer", "readOnly": true, "x-nullable": true}, "created_by": {"title": "Created by", "description": "The user who created this resource", "type": "integer", "readOnly": true, "x-nullable": true}}}, "RoleDefinitionDetail": {"required": ["permissions", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "permissions": {"type": "array", "items": {"type": "string", "enum": ["awx.add_credential", "awx.add_executionenvironment", "awx.add_inventory", "awx.add_notificationtemplate", "awx.add_project", "awx.add_workflowjobtemplate", "awx.adhoc_inventory", "awx.approve_workflowjobtemplate", "awx.change_credential", "awx.change_executionenvironment", "awx.change_instancegroup", "awx.change_inventory", "awx.change_jobtemplate", "awx.change_notificationtemplate", "awx.change_project", "awx.change_workflowjobtemplate", "awx.delete_credential", "awx.delete_executionenvironment", "awx.delete_instancegroup", "awx.delete_inventory", "awx.delete_jobtemplate", "awx.delete_notificationtemplate", "awx.delete_project", "awx.delete_workflowjobtemplate", "awx.execute_jobtemplate", "awx.execute_workflowjobtemplate", "awx.update_inventory", "awx.update_project", "awx.use_credential", "awx.use_instancegroup", "awx.use_inventory", "awx.use_project", "awx.view_credential", "awx.view_instancegroup", "awx.view_inventory", "awx.view_jobtemplate", "awx.view_notificationtemplate", "awx.view_project", "awx.view_workflowjobtemplate", "shared.add_team", "shared.audit_organization", "shared.change_organization", "shared.change_team", "shared.delete_organization", "shared.delete_team", "shared.member_organization", "shared.member_team", "shared.view_organization", "shared.view_team"]}}, "content_type": {"title": "Content type", "description": "The type of resource this applies to", "type": "string", "enum": ["awx.credential", "awx.executionenvironment", "awx.instancegroup", "awx.inventory", "awx.jobtemplate", "awx.notificationtemplate", "awx.project", "awx.workflowjobtemplate", "shared.organization", "shared.team"], "readOnly": true}, "modified": {"title": "Modified", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "created": {"title": "Created", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "name": {"title": "Name", "type": "string", "minLength": 1}, "description": {"title": "Description", "type": "string"}, "managed": {"title": "Managed", "type": "boolean", "readOnly": true}, "modified_by": {"title": "Modified by", "description": "The user who last modified this resource", "type": "integer", "readOnly": true, "x-nullable": true}, "created_by": {"title": "Created by", "description": "The user who created this resource", "type": "integer", "readOnly": true, "x-nullable": true}}}, "RoleTeamAssignment": {"required": ["role_definition"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "created_by": {"title": "Created by", "description": "The user who created this resource", "type": "integer", "readOnly": true, "x-nullable": true}, "content_type": {"title": "Content type", "description": "The type of resource this applies to", "type": "string", "enum": ["awx.credential", "awx.executionenvironment", "awx.instancegroup", "awx.inventory", "awx.jobtemplate", "awx.notificationtemplate", "awx.project", "awx.workflowjobtemplate", "shared.organization", "shared.team"], "readOnly": true}, "object_id": {"title": "Object id", "description": "Primary key of the object this assignment applies to, null value indicates system-wide assignment", "type": "string", "x-nullable": true}, "object_ansible_id": {"title": "Object ansible id", "description": "Resource id of the object this role applies to. Alternative to the object_id field.", "type": "string", "format": "uuid", "x-nullable": true}, "role_definition": {"title": "Role definition", "description": "The role definition which defines permissions conveyed by this assignment", "type": "integer"}, "team": {"title": "Team", "type": "integer"}, "team_ansible_id": {"title": "Team ansible id", "description": "Resource id of the team who will receive permissions from this assignment. Alternative to team field.", "type": "string", "format": "uuid"}}}, "RoleUserAssignment": {"required": ["role_definition"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "description": "The date/time this resource was created", "type": "string", "format": "date-time", "readOnly": true}, "created_by": {"title": "Created by", "description": "The user who created this resource", "type": "integer", "readOnly": true, "x-nullable": true}, "content_type": {"title": "Content type", "description": "The type of resource this applies to", "type": "string", "enum": ["awx.credential", "awx.executionenvironment", "awx.instancegroup", "awx.inventory", "awx.jobtemplate", "awx.notificationtemplate", "awx.project", "awx.workflowjobtemplate", "shared.organization", "shared.team"], "readOnly": true}, "object_id": {"title": "Object id", "description": "Primary key of the object this assignment applies to, null value indicates system-wide assignment", "type": "string", "x-nullable": true}, "object_ansible_id": {"title": "Object ansible id", "description": "Resource id of the object this role applies to. Alternative to the object_id field.", "type": "string", "format": "uuid", "x-nullable": true}, "role_definition": {"title": "Role definition", "description": "The role definition which defines permissions conveyed by this assignment", "type": "integer"}, "user": {"title": "User", "type": "integer"}, "user_ansible_id": {"title": "User ansible id", "description": "Resource id of the user who will receive permissions from this assignment. Alternative to user field.", "type": "string", "format": "uuid", "x-nullable": true}}}, "RoleMetadata": {"required": ["allowed_permissions"], "type": "object", "properties": {"allowed_permissions": {"title": "Allowed permissions", "description": "List of permissions allowed for a role definition, given its content type.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}}}}, "ResourceType": {"required": ["externally_managed"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1}, "externally_managed": {"title": "Externally managed", "type": "boolean"}, "shared_resource_type": {"title": "Shared resource type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}}}, "ResourceList": {"required": ["resource_data"], "type": "object", "properties": {"object_id": {"title": "Object id", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "ansible_id": {"title": "Ansible id", "type": "string", "format": "uuid"}, "service_id": {"title": "Service id", "type": "string", "format": "uuid"}, "resource_type": {"title": "Resource type", "type": "string", "minLength": 1}, "has_serializer": {"title": "Has serializer", "type": "boolean", "readOnly": true}, "resource_data": {"title": "Resource data", "type": "object"}, "url": {"title": "Url", "type": "string", "readOnly": true}}}, "Resource": {"required": ["resource_data"], "type": "object", "properties": {"object_id": {"title": "Object id", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "ansible_id": {"title": "Ansible id", "type": "string", "format": "uuid"}, "service_id": {"title": "Service id", "type": "string", "format": "uuid"}, "resource_type": {"title": "Resource type", "type": "string", "minLength": 1}, "has_serializer": {"title": "Has serializer", "type": "boolean", "readOnly": true}, "resource_data": {"title": "Resource data", "type": "object"}, "url": {"title": "Url", "type": "string", "readOnly": true}}}, "ActivityStream": {"required": ["operation", "object1", "object2"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "timestamp": {"title": "Timestamp", "type": "string", "format": "date-time", "readOnly": true}, "operation": {"title": "Operation", "description": "The action taken with respect to the given object(s).", "type": "string", "enum": ["create", "update", "delete", "associate", "disassociate"], "x-nullable": true}, "changes": {"title": "Changes", "description": "A summary of the new and changed values when an object is created, updated, or deleted", "type": "string", "readOnly": true}, "object1": {"title": "Object1", "description": "For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.", "type": "string", "minLength": 1, "x-nullable": true}, "object2": {"title": "Object2", "description": "Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.", "type": "string", "minLength": 1, "x-nullable": true}, "object_association": {"title": "Object association", "description": "When present, shows the field name of the role or relationship that changed.", "type": "string", "readOnly": true}, "action_node": {"title": "Action node", "description": "The cluster node the activity took place on.", "type": "string", "readOnly": true, "minLength": 1}, "object_type": {"title": "Object type", "description": "When present, shows the model on which the role or relationship was defined.", "type": "string", "readOnly": true}}}, "AdHocCommandEvent": {"required": ["event"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "ad_hoc_command": {"title": "Ad hoc command", "type": "string", "readOnly": true}, "event": {"title": "Event", "type": "string", "enum": ["runner_on_failed", "runner_on_ok", "runner_on_unreachable", "runner_on_skipped", "debug", "verbose", "deprecated", "warning", "system_warning", "error"], "x-nullable": true}, "counter": {"title": "Counter", "type": "integer", "readOnly": true, "minimum": 0}, "event_display": {"title": "Event display", "type": "string", "readOnly": true, "minLength": 1}, "event_data": {"title": "Event data", "type": "object", "default": {}}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "changed": {"title": "Changed", "type": "boolean", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1}, "host": {"title": "Host", "type": "integer", "readOnly": true, "x-nullable": true}, "host_name": {"title": "Host name", "type": "string", "readOnly": true, "minLength": 1}, "stdout": {"title": "Stdout", "type": "string", "readOnly": true, "minLength": 1}, "start_line": {"title": "Start line", "type": "integer", "readOnly": true, "minimum": 0}, "end_line": {"title": "End line", "type": "integer", "readOnly": true, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "readOnly": true, "minimum": 0}}}, "AdHocCommandList": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "default": "run", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "default": "", "x-nullable": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "module_name": {"title": "Module name", "type": "string", "enum": ["command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user"], "default": "command"}, "module_args": {"title": "Module args", "type": "string", "default": "", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "default": 0}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "become_enabled": {"title": "Become enabled", "type": "boolean", "default": false, "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "default": false, "x-nullable": true}}}, "AdHocCommandDetail": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "Job env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "default": "run", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "default": "", "x-nullable": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "module_name": {"title": "Module name", "type": "string", "enum": ["command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user"], "default": "command"}, "module_args": {"title": "Module args", "type": "string", "default": "", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "default": 0}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "become_enabled": {"title": "Become enabled", "type": "boolean", "default": false, "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "default": false, "x-nullable": true}, "host_status_counts": {"title": "Host status counts", "description": "Playbook stats from the Ansible playbook_on_stats event.", "type": "object", "readOnly": true, "x-nullable": true}}}, "AdHocCommandCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}, "Notification": {"required": ["notification_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "notification_template": {"title": "Notification template", "type": "integer", "readOnly": true}, "error": {"title": "Error", "type": "string", "readOnly": true, "minLength": 1}, "status": {"title": "Status", "type": "string", "enum": ["pending", "successful", "failed"], "readOnly": true}, "notifications_sent": {"title": "Notifications sent", "type": "integer", "readOnly": true}, "notification_type": {"title": "Notification type", "type": "string", "enum": ["awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook"], "x-nullable": true}, "recipients": {"title": "Recipients", "type": "string", "readOnly": true, "minLength": 1}, "subject": {"title": "Subject", "type": "string", "readOnly": true, "minLength": 1}, "body": {"title": "Body", "description": "Notification body", "type": "string", "readOnly": true}}}, "AdHocCommandRelaunch": {"type": "object", "properties": {}}, "UnifiedJobStdout": {"type": "object", "properties": {"result_stdout": {"title": "Result stdout", "type": "string", "readOnly": true}}}, "OAuth2Application": {"required": ["name", "client_type", "authorization_grant_type", "organization"], "type": "object", "properties": {"id": {"title": "Id", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 255, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "client_id": {"title": "Client id", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "client_secret": {"title": "Client Secret", "description": "Used for more stringent verification of access to an application when creating a token.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "client_type": {"title": "Client Type", "description": "Set to Public or Confidential depending on how secure the client device is.", "type": "string", "enum": ["confidential", "public"], "x-nullable": true}, "redirect_uris": {"title": "Redirect URIs", "description": "Allowed URIs list, space separated", "type": "string", "x-nullable": true}, "authorization_grant_type": {"title": "Authorization Grant Type", "description": "The Grant type the user must use for acquire tokens for this application.", "type": "string", "enum": ["authorization-code", "password"], "x-nullable": true}, "skip_authorization": {"title": "Skip Authorization", "description": "Set True to skip authorization step for completely trusted applications.", "type": "boolean", "default": false, "x-nullable": true}, "organization": {"title": "Organization", "description": "Organization containing this application.", "type": "integer"}}}, "OAuth2Token": {"type": "object", "properties": {"id": {"title": "Id", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "user": {"title": "User", "description": "The user representing the token owner", "type": "integer", "readOnly": true}, "token": {"title": "Token", "type": "string", "readOnly": true}, "refresh_token": {"title": "Refresh token", "type": "string", "readOnly": true}, "application": {"title": "Application", "type": "integer", "x-nullable": true}, "expires": {"title": "Expires", "type": "string", "format": "date-time", "readOnly": true}, "scope": {"title": "Scope", "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "type": "string", "default": "write", "x-nullable": true}}}, "BulkHost": {"required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "enabled": {"title": "Enabled", "description": "Is this host online and available for running jobs?", "type": "boolean", "default": true, "x-nullable": true}, "instance_id": {"title": "Instance id", "description": "The value used by the remote inventory source to uniquely identify the host", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "variables": {"title": "Variables", "description": "Host variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}}}, "BulkHostCreate": {"required": ["inventory", "hosts"], "type": "object", "properties": {"inventory": {"title": "Inventory", "description": "Primary Key ID of inventory to add hosts to.", "type": "integer"}, "hosts": {"description": "List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]", "type": "array", "items": {"$ref": "#/definitions/BulkHost"}, "maxItems": 100000}}}, "BulkHostDelete": {"required": ["hosts"], "type": "object", "properties": {"hosts": {"description": "List of hosts ids to be deleted, e.g. [105, 130, 131, 200]", "type": "array", "items": {"type": "string", "x-nullable": true}, "maxItems": 100000}}}, "BulkJobNode": {"description": "List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", "required": ["unified_job_template"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "type": "integer", "minimum": 1}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "type": "integer", "minimum": 1}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "job": {"title": "Job", "type": "integer", "x-nullable": true}, "workflow_job": {"title": "Workflow job", "type": "string", "x-nullable": true}, "unified_job_template": {"title": "Unified job template", "description": "Primary key of the template for this job, can be a job template or inventory source.", "type": "integer", "minimum": 1}, "success_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "failure_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "always_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "all_parents_must_converge": {"title": "All parents must converge", "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type": "boolean", "default": false, "x-nullable": true}, "do_not_run": {"title": "Do not run", "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", "type": "boolean", "default": false, "x-nullable": true}, "identifier": {"title": "Identifier", "description": "An identifier coresponding to the workflow job template node that this node was created from.", "type": "string", "maxLength": 512, "x-nullable": true}, "credentials": {"type": "array", "items": {"type": "integer", "minimum": 1}}, "labels": {"type": "array", "items": {"type": "integer", "minimum": 1}}, "instance_groups": {"type": "array", "items": {"type": "integer", "minimum": 1}}}}, "BulkJobLaunch": {"required": ["jobs"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "default": "Bulk Job Launch", "maxLength": 512}, "jobs": {"description": "List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", "type": "array", "items": {"$ref": "#/definitions/BulkJobNode"}}, "description": {"title": "Description", "type": "string", "minLength": 1}, "extra_vars": {"title": "Extra vars", "type": "object"}, "organization": {"title": "Organization", "description": "Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically.", "type": "integer", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer"}, "limit": {"title": "Limit", "type": "string", "minLength": 1}, "scm_branch": {"title": "Scm branch", "type": "string", "minLength": 1}, "skip_tags": {"title": "Skip tags", "type": "string", "minLength": 1}, "job_tags": {"title": "Job tags", "type": "string", "minLength": 1}}}, "ConstructedInventory": {"required": ["name", "organization"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "Organization containing this inventory.", "type": "integer", "x-nullable": true}, "kind": {"title": "Kind", "description": "Kind of inventory being represented.", "type": "string", "enum": ["", "smart", "constructed"], "readOnly": true, "x-nullable": true}, "variables": {"title": "Variables", "description": "Inventory variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}, "has_active_failures": {"title": "Has active failures", "description": "This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", "type": "boolean", "readOnly": true}, "total_hosts": {"title": "Total hosts", "description": "This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "hosts_with_active_failures": {"title": "Hosts with active failures", "description": "This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", "type": "integer", "readOnly": true, "minimum": 0}, "total_groups": {"title": "Total groups", "description": "This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "has_inventory_sources": {"title": "Has inventory sources", "description": "This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", "type": "boolean", "readOnly": true}, "total_inventory_sources": {"title": "Total inventory sources", "description": "Total number of external inventory sources configured within this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "inventory_sources_with_failures": {"title": "Inventory sources with failures", "description": "Number of external inventory sources in this inventory with failures.", "type": "integer", "readOnly": true, "minimum": 0}, "pending_deletion": {"title": "Pending deletion", "description": "Flag indicating the inventory is being deleted.", "type": "boolean", "readOnly": true}, "prevent_instance_group_fallback": {"title": "Prevent instance group fallback", "description": "If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "type": "boolean", "default": false, "x-nullable": true}, "source_vars": {"title": "Source vars", "description": "The source_vars for the related auto-created inventory source, special to constructed inventory.", "type": "string"}, "update_cache_timeout": {"title": "Update cache timeout", "description": "The cache timeout for the related auto-created inventory source, special to constructed inventory", "type": "integer", "minimum": 0, "x-nullable": true}, "limit": {"title": "Limit", "description": "The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.", "type": "string"}, "verbosity": {"title": "Verbosity", "description": "The verbosity level for the related auto-created inventory source, special to constructed inventory", "type": "integer", "maximum": 2, "minimum": 0, "x-nullable": true}}}, "CredentialInputSource": {"required": ["input_field_name", "target_credential", "source_credential"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "input_field_name": {"title": "Input field name", "type": "string", "maxLength": 1024, "minLength": 1, "x-nullable": true}, "metadata": {"title": "Metadata", "type": "object", "default": {}}, "target_credential": {"title": "Target credential", "type": "integer", "x-nullable": true}, "source_credential": {"title": "Source credential", "type": "integer", "x-nullable": true}}}, "CredentialType": {"required": ["name", "kind"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "kind": {"title": "Kind", "type": "string", "enum": ["ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography"], "x-nullable": true}, "namespace": {"title": "Namespace", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "injectors": {"title": "Injectors", "description": "Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}}}, "Credential": {"required": ["name", "credential_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "type": "integer", "x-nullable": true}, "credential_type": {"title": "Credential Type", "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", "type": "integer"}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "kind": {"title": "Kind", "type": "string", "readOnly": true}, "cloud": {"title": "Cloud", "type": "string", "readOnly": true}, "kubernetes": {"title": "Kubernetes", "type": "string", "readOnly": true}}}, "Empty": {"type": "object", "properties": {}}, "CredentialSerializerCreate": {"required": ["name", "credential_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team.", "type": "integer", "x-nullable": true}, "credential_type": {"title": "Credential Type", "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", "type": "integer"}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "kind": {"title": "Kind", "type": "string", "readOnly": true}, "cloud": {"title": "Cloud", "type": "string", "readOnly": true}, "kubernetes": {"title": "Kubernetes", "type": "string", "readOnly": true}, "user": {"title": "User", "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", "type": "integer", "x-nullable": true}, "team": {"title": "Team", "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", "type": "integer", "x-nullable": true}}}, "ResourceAccessListElement": {"required": ["username"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "username": {"title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1, "x-nullable": true}, "first_name": {"title": "First name", "type": "string", "maxLength": 150, "x-nullable": true}, "last_name": {"title": "Last name", "type": "string", "maxLength": 150, "x-nullable": true}, "email": {"title": "Email address", "type": "string", "maxLength": 254, "x-nullable": true}, "is_superuser": {"title": "Superuser status", "description": "Designates that this user has all permissions without explicitly assigning them.", "type": "boolean", "default": false, "x-nullable": true}, "is_system_auditor": {"title": "Is system auditor", "type": "boolean", "default": false}, "password": {"title": "Password", "description": "Field used to change the password.", "type": "string", "default": "", "minLength": 1}, "ldap_dn": {"title": "Ldap dn", "type": "string", "readOnly": true, "minLength": 1}, "last_login": {"title": "Last login", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "external_account": {"title": "External account", "description": "Set if the account is managed by an external service", "type": "string", "readOnly": true}}}, "Copy": {"required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "minLength": 1}}}, "Role": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "readOnly": true}}}, "Team": {"required": ["name", "organization"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "type": "integer"}}}, "User": {"required": ["username"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "username": {"title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1, "x-nullable": true}, "first_name": {"title": "First name", "type": "string", "maxLength": 150, "x-nullable": true}, "last_name": {"title": "Last name", "type": "string", "maxLength": 150, "x-nullable": true}, "email": {"title": "Email address", "type": "string", "maxLength": 254, "x-nullable": true}, "is_superuser": {"title": "Superuser status", "description": "Designates that this user has all permissions without explicitly assigning them.", "type": "boolean", "default": false, "x-nullable": true}, "is_system_auditor": {"title": "Is system auditor", "type": "boolean", "default": false}, "password": {"title": "Password", "description": "Field used to change the password.", "type": "string", "default": "", "minLength": 1}, "ldap_dn": {"title": "Ldap dn", "type": "string", "readOnly": true, "minLength": 1}, "last_login": {"title": "Last login", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "external_account": {"title": "External account", "description": "Set if the account is managed by an external service", "type": "string", "readOnly": true}}}, "ExecutionEnvironment": {"required": ["name", "image"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this execution environment.", "type": "integer", "x-nullable": true}, "image": {"title": "Image location", "description": "The full image location, including the container registry, image name, and version tag.", "type": "string", "maxLength": 1024, "minLength": 1, "x-nullable": true}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "pull": {"title": "Pull", "description": "Pull image before running?", "type": "string", "enum": ["always", "missing", "never"], "default": "", "x-nullable": true}}}, "UnifiedJobTemplate": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}}}, "Group": {"required": ["name", "inventory"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer"}, "variables": {"title": "Variables", "description": "Group variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}}}, "Host": {"required": ["name", "inventory"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer"}, "enabled": {"title": "Enabled", "description": "Is this host online and available for running jobs?", "type": "boolean", "default": true, "x-nullable": true}, "instance_id": {"title": "Instance id", "description": "The value used by the remote inventory source to uniquely identify the host", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "variables": {"title": "Variables", "description": "Host variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}, "has_active_failures": {"title": "Has active failures", "type": "string", "readOnly": true}, "has_inventory_sources": {"title": "Has inventory sources", "type": "string", "readOnly": true}, "last_job": {"title": "Last job", "type": "string", "readOnly": true, "x-nullable": true}, "last_job_host_summary": {"title": "Last job host summary", "type": "integer", "readOnly": true, "x-nullable": true}, "ansible_facts_modified": {"title": "Ansible facts modified", "description": "The date and time ansible_facts was last modified.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}}}, "InventorySource": {"required": ["name", "inventory"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "source": {"title": "Source", "type": "string", "enum": ["file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights", "terraform", "openshift_virtualization"], "x-nullable": true}, "source_path": {"title": "Source path", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "source_vars": {"title": "Source vars", "description": "Inventory source variables in YAML or JSON format.", "type": "string", "default": "", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "credential": {"title": "Credential", "description": "Cloud credential to use for inventory updates.", "type": "integer", "minimum": 1, "x-nullable": true}, "enabled_var": {"title": "Enabled var", "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", "type": "string", "default": "", "x-nullable": true}, "enabled_value": {"title": "Enabled value", "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", "type": "string", "default": "", "x-nullable": true}, "host_filter": {"title": "Host filter", "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "type": "string", "default": "", "x-nullable": true}, "overwrite": {"title": "Overwrite", "description": "Overwrite local groups and hosts from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "overwrite_vars": {"title": "Overwrite vars", "description": "Overwrite local variables from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "custom_virtualenv": {"title": "Custom virtualenv", "description": "Local absolute file path containing a custom Python virtualenv to use", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2], "default": 1}, "limit": {"title": "Limit", "description": "Enter host, group or pattern match", "type": "string", "default": "", "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "update_on_launch": {"title": "Update on launch", "type": "boolean", "default": false, "x-nullable": true}, "update_cache_timeout": {"title": "Update cache timeout", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "source_project": {"title": "Source project", "description": "Project containing inventory file used as source.", "type": "string", "x-nullable": true}, "last_update_failed": {"title": "Last update failed", "type": "boolean", "readOnly": true}, "last_updated": {"title": "Last updated", "type": "string", "format": "date-time", "readOnly": true}}}, "JobEvent": {"required": ["event"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "job": {"title": "Job", "type": "string", "readOnly": true, "x-nullable": true}, "event": {"title": "Event", "type": "string", "enum": ["runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error"], "x-nullable": true}, "counter": {"title": "Counter", "type": "integer", "readOnly": true, "minimum": 0}, "event_display": {"title": "Event display", "type": "string", "readOnly": true, "minLength": 1}, "event_data": {"title": "Event data", "type": "object", "default": {}}, "event_level": {"title": "Event level", "type": "integer", "readOnly": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "changed": {"title": "Changed", "type": "boolean", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1}, "parent_uuid": {"title": "Parent uuid", "type": "string", "readOnly": true, "minLength": 1}, "host": {"title": "Host", "type": "integer", "readOnly": true, "x-nullable": true}, "host_name": {"title": "Host name", "type": "string", "readOnly": true, "minLength": 1}, "playbook": {"title": "Playbook", "type": "string", "readOnly": true, "minLength": 1}, "play": {"title": "Play", "type": "string", "readOnly": true, "minLength": 1}, "task": {"title": "Task", "type": "string", "readOnly": true, "minLength": 1}, "role": {"title": "Role", "type": "string", "readOnly": true, "minLength": 1}, "stdout": {"title": "Stdout", "type": "string", "readOnly": true, "minLength": 1}, "start_line": {"title": "Start line", "type": "integer", "readOnly": true, "minimum": 0}, "end_line": {"title": "End line", "type": "integer", "readOnly": true, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "readOnly": true, "minimum": 0}}}, "JobHostSummary": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "job": {"title": "Job", "type": "string", "readOnly": true}, "host": {"title": "Host", "type": "integer", "readOnly": true, "x-nullable": true}, "constructed_host": {"title": "Constructed host", "description": "Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.", "type": "integer", "readOnly": true, "x-nullable": true}, "host_name": {"title": "Host name", "type": "string", "readOnly": true, "default": "", "minLength": 1}, "changed": {"title": "Changed", "type": "integer", "readOnly": true, "minimum": 0}, "dark": {"title": "Dark", "type": "integer", "readOnly": true, "minimum": 0}, "failures": {"title": "Failures", "type": "integer", "readOnly": true, "minimum": 0}, "ok": {"title": "Ok", "type": "integer", "readOnly": true, "minimum": 0}, "processed": {"title": "Processed", "type": "integer", "readOnly": true, "minimum": 0}, "skipped": {"title": "Skipped", "type": "integer", "readOnly": true, "minimum": 0}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "ignored": {"title": "Ignored", "type": "integer", "readOnly": true, "minimum": 0}, "rescued": {"title": "Rescued", "type": "integer", "readOnly": true, "minimum": 0}}}, "GroupVariableData": {"type": "object", "properties": {"variables": {"title": "Variables", "description": "Group variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}}}, "HostMetricSummaryMonthly": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "date": {"title": "Date", "type": "string", "format": "date", "readOnly": true}, "license_consumed": {"title": "License consumed", "description": "How many unique hosts are consumed from the license", "type": "integer", "readOnly": true}, "license_capacity": {"title": "License capacity", "description": "'License capacity as max. number of unique hosts", "type": "integer", "readOnly": true}, "hosts_added": {"title": "Hosts added", "description": "How many hosts were added in the associated month, consuming more license capacity", "type": "integer", "readOnly": true}, "hosts_deleted": {"title": "Hosts deleted", "description": "How many hosts were deleted in the associated month, freeing the license capacity", "type": "integer", "readOnly": true}, "indirectly_managed_hosts": {"title": "Indirectly managed hosts", "description": "Manually entered number indirectly managed hosts for a certain month", "type": "integer", "readOnly": true}}}, "HostMetric": {"required": ["hostname", "last_automation"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "hostname": {"title": "Hostname", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "first_automation": {"title": "First automation", "description": "When the host was first automated against", "type": "string", "format": "date-time", "readOnly": true}, "last_automation": {"title": "Last automation", "description": "When the host was last automated against", "type": "string", "format": "date-time"}, "last_deleted": {"title": "Last deleted", "description": "When the host was last deleted", "type": "string", "format": "date-time", "x-nullable": true}, "automated_counter": {"title": "Automated counter", "description": "How many times was the host automated", "type": "integer", "default": 0, "maximum": 9223372036854775807, "minimum": -9223372036854775808}, "deleted_counter": {"title": "Deleted counter", "description": "How many times was the host deleted", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "deleted": {"title": "Deleted", "description": "Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption", "type": "boolean", "default": false, "x-nullable": true}, "used_in_inventories": {"title": "Used in inventories", "description": "How many inventories contain this host", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}}}, "AnsibleFacts": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}}}, "Inventory": {"required": ["name", "organization"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "Organization containing this inventory.", "type": "integer", "x-nullable": true}, "kind": {"title": "Kind", "description": "Kind of inventory being represented.", "type": "string", "enum": ["", "smart", "constructed"], "default": "", "x-nullable": true}, "host_filter": {"title": "Host filter", "description": "Filter that will be applied to the hosts of this inventory.", "type": "string", "x-nullable": true}, "variables": {"title": "Variables", "description": "Inventory variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}, "has_active_failures": {"title": "Has active failures", "description": "This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", "type": "boolean", "readOnly": true}, "total_hosts": {"title": "Total hosts", "description": "This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "hosts_with_active_failures": {"title": "Hosts with active failures", "description": "This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", "type": "integer", "readOnly": true, "minimum": 0}, "total_groups": {"title": "Total groups", "description": "This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "has_inventory_sources": {"title": "Has inventory sources", "description": "This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", "type": "boolean", "readOnly": true}, "total_inventory_sources": {"title": "Total inventory sources", "description": "Total number of external inventory sources configured within this inventory.", "type": "integer", "readOnly": true, "minimum": 0}, "inventory_sources_with_failures": {"title": "Inventory sources with failures", "description": "Number of external inventory sources in this inventory with failures.", "type": "integer", "readOnly": true, "minimum": 0}, "pending_deletion": {"title": "Pending deletion", "description": "Flag indicating the inventory is being deleted.", "type": "boolean", "readOnly": true}, "prevent_instance_group_fallback": {"title": "Prevent instance group fallback", "description": "If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "type": "boolean", "default": false, "x-nullable": true}}}, "HostVariableData": {"type": "object", "properties": {"variables": {"title": "Variables", "description": "Host variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}}}, "InstanceGroup": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 250, "minLength": 1, "x-nullable": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "capacity": {"title": "Capacity", "type": "string", "readOnly": true}, "consumed_capacity": {"title": "Consumed capacity", "type": "string", "readOnly": true}, "percent_capacity_remaining": {"title": "Percent capacity remaining", "type": "string", "readOnly": true}, "jobs_running": {"title": "Jobs running", "type": "string", "readOnly": true}, "max_concurrent_jobs": {"title": "Max Concurrent Jobs", "description": "Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.", "type": "integer", "default": 0, "minimum": 0}, "max_forks": {"title": "Max Forks", "description": "Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.", "type": "integer", "default": 0, "minimum": 0}, "jobs_total": {"title": "Jobs total", "description": "Count of all jobs that target this instance group", "type": "integer", "readOnly": true}, "instances": {"title": "Instances", "type": "string", "readOnly": true}, "is_container_group": {"title": "Is container group", "description": "Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.", "type": "boolean"}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "policy_instance_percentage": {"title": "Policy Instance Percentage", "description": "Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.", "type": "integer", "default": 0, "maximum": 100, "minimum": 0}, "policy_instance_minimum": {"title": "Policy Instance Minimum", "description": "Static minimum number of Instances that will be automatically assign to this group when new instances come online.", "type": "integer", "default": 0, "minimum": 0}, "policy_instance_list": {"description": "List of exact-match Instances that will be assigned to this group", "type": "array", "items": {"type": "string", "minLength": 1}}, "pod_spec_override": {"title": "Pod spec override", "type": "string", "default": "", "x-nullable": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}}}, "Instance": {"required": ["hostname"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "hostname": {"title": "Hostname", "type": "string", "maxLength": 250, "minLength": 1, "x-nullable": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "last_seen": {"title": "Last seen", "description": "Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "health_check_started": {"title": "Health check started", "description": "The last time a health check was initiated on this instance.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "health_check_pending": {"title": "Health check pending", "type": "string", "readOnly": true}, "last_health_check": {"title": "Last health check", "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "errors": {"title": "Errors", "description": "Any error details from the last health check.", "type": "string", "readOnly": true, "minLength": 1}, "capacity_adjustment": {"title": "Capacity adjustment", "type": "string", "format": "decimal", "default": "1.00"}, "version": {"title": "Version", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "capacity": {"title": "Capacity", "type": "integer", "readOnly": true, "minimum": 0}, "consumed_capacity": {"title": "Consumed capacity", "type": "string", "readOnly": true}, "percent_capacity_remaining": {"title": "Percent capacity remaining", "type": "string", "readOnly": true}, "jobs_running": {"title": "Jobs running", "description": "Count of jobs in the running or waiting state that are targeted for this instance", "type": "integer", "readOnly": true}, "jobs_total": {"title": "Jobs total", "description": "Count of all jobs that target this instance", "type": "integer", "readOnly": true}, "cpu": {"title": "Cpu", "type": "string", "format": "decimal", "readOnly": true}, "memory": {"title": "Memory", "description": "Total system memory of this instance in bytes.", "type": "integer", "readOnly": true}, "cpu_capacity": {"title": "Cpu capacity", "type": "integer", "readOnly": true}, "mem_capacity": {"title": "Mem capacity", "type": "integer", "readOnly": true}, "enabled": {"title": "Enabled", "type": "boolean", "default": true, "x-nullable": true}, "managed_by_policy": {"title": "Managed by policy", "type": "boolean", "default": true, "x-nullable": true}, "node_type": {"title": "Node type", "description": "Role that this node plays in the mesh.", "type": "string", "enum": ["control", "execution", "hybrid", "hop"], "default": "execution", "x-nullable": true}, "node_state": {"title": "Node state", "description": "Indicates the current life cycle stage of this instance.", "type": "string", "enum": ["provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail"], "default": "installed", "x-nullable": true}, "managed": {"title": "Managed", "description": "If True, this instance is managed by the control plane.", "type": "boolean", "readOnly": true}, "ip_address": {"title": "Ip address", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "peers": {"description": "Primary keys of receptor addresses to peer to.", "type": "array", "items": {"description": "Primary keys of receptor addresses to peer to.", "type": "integer"}, "uniqueItems": true}, "reverse_peers": {"title": "Reverse peers", "type": "string", "readOnly": true}, "listener_port": {"title": "Listener port", "type": "integer", "x-nullable": true}, "peers_from_control_nodes": {"title": "Peers from control nodes", "type": "boolean"}, "protocol": {"title": "Protocol", "type": "string", "readOnly": true}}}, "UnifiedJobList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}}}, "InstanceHealthCheck": {"type": "object", "properties": {"uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "hostname": {"title": "Hostname", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "ip_address": {"title": "Ip address", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "version": {"title": "Version", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "last_health_check": {"title": "Last health check", "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "errors": {"title": "Errors", "description": "Any error details from the last health check.", "type": "string", "readOnly": true, "minLength": 1}, "cpu": {"title": "Cpu", "type": "string", "format": "decimal", "readOnly": true}, "memory": {"title": "Memory", "description": "Total system memory of this instance in bytes.", "type": "integer", "readOnly": true}, "cpu_capacity": {"title": "Cpu capacity", "type": "integer", "readOnly": true}, "mem_capacity": {"title": "Mem capacity", "type": "integer", "readOnly": true}, "capacity": {"title": "Capacity", "type": "integer", "readOnly": true}}}, "ReceptorAddress": {"required": ["address", "instance"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "address": {"title": "Address", "description": "Routable address for this instance.", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true}, "port": {"title": "Port", "description": "Port for the address.", "type": "integer", "default": 27199, "maximum": 65535, "minimum": 0}, "protocol": {"title": "Protocol", "description": "Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'.", "type": "string", "enum": ["tcp", "ws", "wss"], "default": "tcp", "x-nullable": true}, "websocket_path": {"title": "Websocket path", "description": "Websocket path.", "type": "string", "default": "", "maxLength": 255, "x-nullable": true}, "is_internal": {"title": "Is internal", "description": "If True, only routable within the Kubernetes cluster.", "type": "boolean", "default": false, "x-nullable": true}, "canonical": {"title": "Canonical", "description": "If True, this address is the canonical address for the instance.", "type": "boolean", "default": false, "x-nullable": true}, "instance": {"title": "Instance", "type": "integer"}, "peers_from_control_nodes": {"title": "Peers from control nodes", "description": "If True, control plane cluster nodes should automatically peer to it.", "type": "boolean", "default": false, "x-nullable": true}, "full_address": {"title": "Full address", "type": "string", "readOnly": true}}}, "JobTemplate": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "default": "run", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "project": {"title": "Project", "type": "string", "x-nullable": true}, "playbook": {"title": "Playbook", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "limit": {"title": "Limit", "type": "string", "default": "", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "default": 0}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "default": "", "x-nullable": true}, "force_handlers": {"title": "Force handlers", "type": "boolean", "default": false, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "start_at_task": {"title": "Start at task", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "use_fact_cache": {"title": "Use fact cache", "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", "type": "boolean", "default": false, "x-nullable": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this template.", "type": "integer", "readOnly": true, "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "host_config_key": {"title": "Host config key", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "ask_scm_branch_on_launch": {"title": "Ask scm branch on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_diff_mode_on_launch": {"title": "Ask diff mode on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_variables_on_launch": {"title": "Ask variables on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_limit_on_launch": {"title": "Ask limit on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_tags_on_launch": {"title": "Ask tags on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_skip_tags_on_launch": {"title": "Ask skip tags on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_job_type_on_launch": {"title": "Ask job type on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_verbosity_on_launch": {"title": "Ask verbosity on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_inventory_on_launch": {"title": "Ask inventory on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_credential_on_launch": {"title": "Ask credential on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_execution_environment_on_launch": {"title": "Ask execution environment on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_labels_on_launch": {"title": "Ask labels on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_forks_on_launch": {"title": "Ask forks on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_job_slice_count_on_launch": {"title": "Ask job slice count on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_timeout_on_launch": {"title": "Ask timeout on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_instance_groups_on_launch": {"title": "Ask instance groups on launch", "type": "boolean", "default": false, "x-nullable": true}, "survey_enabled": {"title": "Survey enabled", "type": "boolean", "default": false, "x-nullable": true}, "become_enabled": {"title": "Become enabled", "type": "boolean", "default": false, "x-nullable": true}, "diff_mode": {"title": "Diff mode", "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", "type": "boolean", "default": false, "x-nullable": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "custom_virtualenv": {"title": "Custom virtualenv", "description": "Local absolute file path containing a custom Python virtualenv to use", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "description": "The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.", "type": "integer", "default": 1, "maximum": 2147483647, "minimum": 0}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "prevent_instance_group_fallback": {"title": "Prevent instance group fallback", "description": "If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", "type": "boolean", "default": false, "x-nullable": true}}}, "Label": {"required": ["name", "organization"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "organization": {"title": "Organization", "description": "Organization this label belongs to.", "type": "integer"}}}, "InventoryScript": {"type": "object", "properties": {}}, "GroupTree": {"required": ["name", "inventory"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer"}, "variables": {"title": "Variables", "description": "Group variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}, "children": {"title": "Children", "type": "string", "readOnly": true}}}, "InventorySourceUpdate": {"type": "object", "properties": {"can_update": {"title": "Can update", "type": "boolean", "readOnly": true}}}, "InventoryVariableData": {"type": "object", "properties": {"variables": {"title": "Variables", "description": "Inventory variables in JSON or YAML format.", "type": "string", "default": "", "x-nullable": true}}}, "InventoryUpdateList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "source": {"title": "Source", "type": "string", "enum": ["file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights", "terraform", "openshift_virtualization"], "x-nullable": true}, "source_path": {"title": "Source path", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "source_vars": {"title": "Source vars", "description": "Inventory source variables in YAML or JSON format.", "type": "string", "default": "", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "credential": {"title": "Credential", "description": "Cloud credential to use for inventory updates.", "type": "integer", "minimum": 1, "x-nullable": true}, "enabled_var": {"title": "Enabled var", "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", "type": "string", "default": "", "x-nullable": true}, "enabled_value": {"title": "Enabled value", "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", "type": "string", "default": "", "x-nullable": true}, "host_filter": {"title": "Host filter", "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "type": "string", "default": "", "x-nullable": true}, "overwrite": {"title": "Overwrite", "description": "Overwrite local groups and hosts from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "overwrite_vars": {"title": "Overwrite vars", "description": "Overwrite local variables from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "custom_virtualenv": {"title": "Custom virtualenv", "type": "string", "readOnly": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2], "default": 1}, "limit": {"title": "Limit", "description": "Enter host, group or pattern match", "type": "string", "default": "", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "inventory_source": {"title": "Inventory source", "type": "string", "readOnly": true}, "license_error": {"title": "License error", "type": "boolean", "readOnly": true}, "org_host_limit_error": {"title": "Org host limit error", "type": "boolean", "readOnly": true}, "source_project_update": {"title": "Source project update", "description": "Inventory files from this Project Update were used for the inventory update.", "type": "string", "x-nullable": true}, "instance_group": {"title": "Instance group", "description": "The Instance group the job was run under", "type": "integer", "x-nullable": true}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", "type": "string", "readOnly": true, "minLength": 1}}}, "NotificationTemplate": {"required": ["name", "organization", "notification_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "type": "integer", "x-nullable": true}, "notification_type": {"title": "Notification type", "type": "string", "enum": ["awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook"], "x-nullable": true}, "notification_configuration": {"title": "Notification configuration", "type": "object", "default": {}}, "messages": {"title": "Messages", "description": "Optional custom messages for notification template.", "type": "object", "default": {"started": null, "success": null, "error": null, "workflow_approval": null}, "x-nullable": true}}}, "Schedule": {"required": ["rrule", "name", "unified_job_template"], "type": "object", "properties": {"rrule": {"title": "Rrule", "description": "A value representing the schedules iCal recurrence rule.", "type": "string", "minLength": 1, "x-nullable": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "unified_job_template": {"title": "Unified job template", "type": "integer"}, "enabled": {"title": "Enabled", "description": "Enables processing of this schedule.", "type": "boolean", "default": true, "x-nullable": true}, "dtstart": {"title": "Dtstart", "description": "The first occurrence of the schedule occurs on or after this time.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "dtend": {"title": "Dtend", "description": "The last occurrence of the schedule occurs before this time, aftewards the schedule expires.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "next_run": {"title": "Next run", "description": "The next time that the scheduled action will run.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "timezone": {"title": "Timezone", "description": "The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.", "type": "string", "readOnly": true}, "until": {"title": "Until", "description": "The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned", "type": "string", "readOnly": true}}}, "InventoryUpdateDetail": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "source": {"title": "Source", "type": "string", "enum": ["file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights", "terraform", "openshift_virtualization"], "x-nullable": true}, "source_path": {"title": "Source path", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "source_vars": {"title": "Source vars", "description": "Inventory source variables in YAML or JSON format.", "type": "string", "default": "", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "credential": {"title": "Credential", "description": "Cloud credential to use for inventory updates.", "type": "integer", "minimum": 1, "x-nullable": true}, "enabled_var": {"title": "Enabled var", "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", "type": "string", "default": "", "x-nullable": true}, "enabled_value": {"title": "Enabled value", "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", "type": "string", "default": "", "x-nullable": true}, "host_filter": {"title": "Host filter", "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", "type": "string", "default": "", "x-nullable": true}, "overwrite": {"title": "Overwrite", "description": "Overwrite local groups and hosts from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "overwrite_vars": {"title": "Overwrite vars", "description": "Overwrite local variables from remote inventory source.", "type": "boolean", "default": false, "x-nullable": true}, "custom_virtualenv": {"title": "Custom virtualenv", "type": "string", "readOnly": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2], "default": 1}, "limit": {"title": "Limit", "description": "Enter host, group or pattern match", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "inventory_source": {"title": "Inventory source", "type": "string", "readOnly": true}, "license_error": {"title": "License error", "type": "boolean", "readOnly": true}, "org_host_limit_error": {"title": "Org host limit error", "type": "boolean", "readOnly": true}, "source_project_update": {"title": "Source project update", "description": "Inventory files from this Project Update were used for the inventory update.", "type": "string", "x-nullable": true}, "instance_group": {"title": "Instance group", "description": "The Instance group the job was run under", "type": "integer", "x-nullable": true}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", "type": "string", "readOnly": true, "minLength": 1}, "source_project": {"title": "Source project", "description": "The project used for this job.", "type": "string", "readOnly": true}}}, "InventoryUpdateCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}, "InventoryUpdateEvent": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "event": {"title": "Event", "type": "string", "readOnly": true}, "counter": {"title": "Counter", "type": "integer", "readOnly": true, "minimum": 0}, "event_display": {"title": "Event display", "type": "string", "readOnly": true, "minLength": 1}, "event_data": {"title": "Event data", "type": "object", "default": {}}, "failed": {"title": "Failed", "type": "string", "readOnly": true}, "changed": {"title": "Changed", "type": "string", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1}, "stdout": {"title": "Stdout", "type": "string", "readOnly": true, "minLength": 1}, "start_line": {"title": "Start line", "type": "integer", "readOnly": true, "minimum": 0}, "end_line": {"title": "End line", "type": "integer", "readOnly": true, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "readOnly": true, "minimum": 0}, "inventory_update": {"title": "Inventory update", "type": "string", "readOnly": true}}}, "JobList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check", "scan"], "default": "run", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "project": {"title": "Project", "type": "string", "x-nullable": true}, "playbook": {"title": "Playbook", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "limit": {"title": "Limit", "type": "string", "default": "", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "default": 0}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "default": "", "x-nullable": true}, "force_handlers": {"title": "Force handlers", "type": "boolean", "default": false, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "start_at_task": {"title": "Start at task", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "use_fact_cache": {"title": "Use fact cache", "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", "type": "boolean", "default": false, "x-nullable": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this unified job.", "type": "integer", "readOnly": true, "x-nullable": true}, "job_template": {"title": "Job template", "type": "string", "x-nullable": true}, "passwords_needed_to_start": {"title": "Passwords needed to start", "type": "string", "readOnly": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "artifacts": {"title": "Artifacts", "type": "string", "readOnly": true}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision from the Project used for this job, if available", "type": "string", "readOnly": true, "minLength": 1}, "instance_group": {"title": "Instance group", "description": "The Instance group the job was run under", "type": "integer", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", "type": "boolean", "default": false, "x-nullable": true}, "job_slice_number": {"title": "Job slice number", "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "job_slice_count": {"title": "Job slice count", "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", "type": "integer", "default": 1, "maximum": 2147483647, "minimum": 0}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "webhook_guid": {"title": "Webhook guid", "description": "Unique identifier of the event that triggered this webhook", "type": "string", "maxLength": 128, "x-nullable": true}}}, "JobLaunch": {"type": "object", "properties": {"can_start_without_user_input": {"title": "Can start without user input", "type": "boolean", "readOnly": true}, "passwords_needed_to_start": {"title": "Passwords needed to start", "type": "string", "readOnly": true}, "extra_vars": {"title": "Extra vars", "type": "object"}, "inventory": {"title": "Inventory", "type": "integer"}, "scm_branch": {"title": "Scm branch", "type": "string"}, "limit": {"title": "Limit", "type": "string"}, "job_tags": {"title": "Job tags", "type": "string"}, "skip_tags": {"title": "Skip tags", "type": "string"}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"]}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5]}, "diff_mode": {"title": "Diff mode", "type": "boolean"}, "credentials": {"type": "array", "items": {"type": "integer"}, "uniqueItems": true}, "credential_passwords": {"title": "Credential passwords", "type": "string"}, "ask_scm_branch_on_launch": {"title": "Ask scm branch on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_variables_on_launch": {"title": "Ask variables on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_tags_on_launch": {"title": "Ask tags on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_diff_mode_on_launch": {"title": "Ask diff mode on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_skip_tags_on_launch": {"title": "Ask skip tags on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_job_type_on_launch": {"title": "Ask job type on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_limit_on_launch": {"title": "Ask limit on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_verbosity_on_launch": {"title": "Ask verbosity on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_inventory_on_launch": {"title": "Ask inventory on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_credential_on_launch": {"title": "Ask credential on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_execution_environment_on_launch": {"title": "Ask execution environment on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_labels_on_launch": {"title": "Ask labels on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_forks_on_launch": {"title": "Ask forks on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_job_slice_count_on_launch": {"title": "Ask job slice count on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_timeout_on_launch": {"title": "Ask timeout on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_instance_groups_on_launch": {"title": "Ask instance groups on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "survey_enabled": {"title": "Survey enabled", "type": "string", "readOnly": true}, "variables_needed_to_start": {"title": "Variables needed to start", "type": "string", "readOnly": true}, "credential_needed_to_start": {"title": "Credential needed to start", "type": "string", "readOnly": true}, "inventory_needed_to_start": {"title": "Inventory needed to start", "type": "string", "readOnly": true}, "job_template_data": {"title": "Job template data", "type": "string", "readOnly": true}, "defaults": {"title": "Defaults", "type": "string", "readOnly": true}, "execution_environment": {"title": "Execution environment", "type": "integer"}, "labels": {"type": "array", "items": {"type": "integer"}, "uniqueItems": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0}, "timeout": {"title": "Timeout", "type": "integer"}, "instance_groups": {"type": "array", "items": {"type": "integer"}, "uniqueItems": true}}}, "WorkflowJobList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "workflow_job_template": {"title": "Workflow job template", "type": "string", "x-nullable": true}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "job_template": {"title": "Job template", "description": "If automatically created for a sliced job run, the job template the workflow job was created from.", "type": "string", "x-nullable": true}, "is_sliced_job": {"title": "Is sliced job", "type": "boolean", "default": false, "x-nullable": true}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "webhook_guid": {"title": "Webhook guid", "description": "Unique identifier of the event that triggered this webhook", "type": "string", "maxLength": 128, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}}}, "JobDetail": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check", "scan"], "default": "run", "x-nullable": true}, "inventory": {"title": "Inventory", "type": "integer", "x-nullable": true}, "project": {"title": "Project", "type": "string", "x-nullable": true}, "playbook": {"title": "Playbook", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "Scm branch", "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "limit": {"title": "Limit", "type": "string", "default": "", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "default": 0}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "default": "", "x-nullable": true}, "force_handlers": {"title": "Force handlers", "type": "boolean", "default": false, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "start_at_task": {"title": "Start at task", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "use_fact_cache": {"title": "Use fact cache", "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", "type": "boolean", "default": false, "x-nullable": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this unified job.", "type": "integer", "readOnly": true, "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "controller_node": {"title": "Controller node", "description": "The instance that managed the execution environment.", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "job_template": {"title": "Job template", "type": "string", "x-nullable": true}, "passwords_needed_to_start": {"title": "Passwords needed to start", "type": "string", "readOnly": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "artifacts": {"title": "Artifacts", "type": "string", "readOnly": true}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision from the Project used for this job, if available", "type": "string", "readOnly": true, "minLength": 1}, "instance_group": {"title": "Instance group", "description": "The Instance group the job was run under", "type": "integer", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", "type": "boolean", "default": false, "x-nullable": true}, "job_slice_number": {"title": "Job slice number", "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "job_slice_count": {"title": "Job slice count", "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", "type": "integer", "default": 1, "maximum": 2147483647, "minimum": 0}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "webhook_guid": {"title": "Webhook guid", "description": "Unique identifier of the event that triggered this webhook", "type": "string", "maxLength": 128, "x-nullable": true}, "host_status_counts": {"title": "Host status counts", "description": "Playbook stats from the Ansible playbook_on_stats event.", "type": "object", "readOnly": true, "x-nullable": true}, "playbook_counts": {"title": "Playbook counts", "description": "A count of all plays and tasks for the job run.", "type": "string", "readOnly": true}, "custom_virtualenv": {"title": "Custom virtualenv", "type": "string", "readOnly": true}}}, "JobCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}, "JobCreateSchedule": {"type": "object", "properties": {"can_schedule": {"title": "Can schedule", "type": "string", "readOnly": true}, "prompts": {"title": "Prompts", "type": "string", "readOnly": true}}}, "JobRelaunch": {"required": ["credential_passwords"], "type": "object", "properties": {"passwords_needed_to_start": {"title": "Passwords needed to start", "type": "string", "readOnly": true}, "retry_counts": {"title": "Retry counts", "type": "string", "readOnly": true}, "hosts": {"title": "Hosts", "type": "string", "enum": ["all", "failed"], "default": "all", "x-nullable": true}, "credential_passwords": {"title": "Credential passwords", "type": "string"}}}, "Organization": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "max_hosts": {"title": "Max hosts", "description": "Maximum number of hosts allowed to be managed by this organization.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "custom_virtualenv": {"title": "Custom virtualenv", "description": "Local absolute file path containing a custom Python virtualenv to use", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "default_environment": {"title": "Default environment", "description": "The default execution environment for jobs run by this organization.", "type": "integer", "x-nullable": true}}}, "OrganizationCredentialSerializerCreate": {"required": ["name", "credential_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team.", "type": "integer", "x-nullable": true}, "credential_type": {"title": "Credential Type", "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", "type": "integer"}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "kind": {"title": "Kind", "type": "string", "readOnly": true}, "cloud": {"title": "Cloud", "type": "string", "readOnly": true}, "kubernetes": {"title": "Kubernetes", "type": "string", "readOnly": true}}}, "Project": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "local_path": {"title": "Local path", "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "type": "string", "maxLength": 1024, "x-nullable": true}, "scm_type": {"title": "SCM Type", "description": "Specifies the source control system used to store the project.", "type": "string", "enum": ["", "git", "svn", "insights", "archive"], "default": "", "x-nullable": true}, "scm_url": {"title": "SCM URL", "description": "The location where the project is stored.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "SCM Branch", "description": "Specific branch, tag or commit to checkout.", "type": "string", "default": "", "maxLength": 256, "x-nullable": true}, "scm_refspec": {"title": "SCM refspec", "description": "For git projects, an additional refspec to fetch.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_clean": {"title": "Scm clean", "description": "Discard any local changes before syncing the project.", "type": "boolean", "default": false, "x-nullable": true}, "scm_track_submodules": {"title": "Scm track submodules", "description": "Track submodules latest commits on defined branch.", "type": "boolean", "default": false, "x-nullable": true}, "scm_delete_on_update": {"title": "Scm delete on update", "description": "Delete the project before syncing.", "type": "boolean", "default": false, "x-nullable": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "scm_revision": {"title": "SCM Revision", "description": "The last revision fetched by a project update", "type": "string", "readOnly": true, "minLength": 1}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing"], "readOnly": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this template.", "type": "integer", "x-nullable": true}, "scm_update_on_launch": {"title": "Scm update on launch", "description": "Update the project when a job is launched that uses the project.", "type": "boolean", "default": false, "x-nullable": true}, "scm_update_cache_timeout": {"title": "Scm update cache timeout", "description": "The number of seconds after the last project update ran that a new project update will be launched as a job dependency.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": 0}, "allow_override": {"title": "Allow override", "description": "Allow changing the SCM branch or revision in a job template that uses this project.", "type": "boolean", "default": false, "x-nullable": true}, "custom_virtualenv": {"title": "Custom virtualenv", "description": "Local absolute file path containing a custom Python virtualenv to use", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "default_environment": {"title": "Default environment", "description": "The default execution environment for jobs run using this project.", "type": "integer", "x-nullable": true}, "signature_validation_credential": {"title": "Signature validation credential", "description": "An optional credential used for validating files in the project against unexpected changes.", "type": "integer", "x-nullable": true}, "last_update_failed": {"title": "Last update failed", "type": "boolean", "readOnly": true}, "last_updated": {"title": "Last updated", "type": "string", "format": "date-time", "readOnly": true}}}, "WorkflowJobTemplate": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating"], "readOnly": true}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "organization": {"title": "Organization", "description": "The organization used to determine access to this template.", "type": "integer", "x-nullable": true}, "survey_enabled": {"title": "Survey enabled", "type": "boolean", "default": false, "x-nullable": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "ask_variables_on_launch": {"title": "Ask variables on launch", "type": "boolean", "default": false, "x-nullable": true}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "ask_inventory_on_launch": {"title": "Ask inventory on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_scm_branch_on_launch": {"title": "Ask scm branch on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_limit_on_launch": {"title": "Ask limit on launch", "type": "boolean", "default": false, "x-nullable": true}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "ask_labels_on_launch": {"title": "Ask labels on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_skip_tags_on_launch": {"title": "Ask skip tags on launch", "type": "boolean", "default": false, "x-nullable": true}, "ask_tags_on_launch": {"title": "Ask tags on launch", "type": "boolean", "default": false, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}}}, "ProjectUpdateList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "local_path": {"title": "Local path", "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "type": "string", "maxLength": 1024, "x-nullable": true}, "scm_type": {"title": "SCM Type", "description": "Specifies the source control system used to store the project.", "type": "string", "enum": ["", "git", "svn", "insights", "archive"], "default": "", "x-nullable": true}, "scm_url": {"title": "SCM URL", "description": "The location where the project is stored.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "SCM Branch", "description": "Specific branch, tag or commit to checkout.", "type": "string", "default": "", "maxLength": 256, "x-nullable": true}, "scm_refspec": {"title": "SCM refspec", "description": "For git projects, an additional refspec to fetch.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_clean": {"title": "Scm clean", "description": "Discard any local changes before syncing the project.", "type": "boolean", "default": false, "x-nullable": true}, "scm_track_submodules": {"title": "Scm track submodules", "description": "Track submodules latest commits on defined branch.", "type": "boolean", "default": false, "x-nullable": true}, "scm_delete_on_update": {"title": "Scm delete on update", "description": "Delete the project before syncing.", "type": "boolean", "default": false, "x-nullable": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision discovered by this update for the given project and branch.", "type": "string", "readOnly": true, "minLength": 1}, "project": {"title": "Project", "type": "string", "readOnly": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "default": "check", "x-nullable": true}, "job_tags": {"title": "Job tags", "description": "Parts of the project update playbook that will be run.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}}}, "ProjectUpdateDetail": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "local_path": {"title": "Local path", "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "type": "string", "maxLength": 1024, "x-nullable": true}, "scm_type": {"title": "SCM Type", "description": "Specifies the source control system used to store the project.", "type": "string", "enum": ["", "git", "svn", "insights", "archive"], "default": "", "x-nullable": true}, "scm_url": {"title": "SCM URL", "description": "The location where the project is stored.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_branch": {"title": "SCM Branch", "description": "Specific branch, tag or commit to checkout.", "type": "string", "default": "", "maxLength": 256, "x-nullable": true}, "scm_refspec": {"title": "SCM refspec", "description": "For git projects, an additional refspec to fetch.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "scm_clean": {"title": "Scm clean", "description": "Discard any local changes before syncing the project.", "type": "boolean", "default": false, "x-nullable": true}, "scm_track_submodules": {"title": "Scm track submodules", "description": "Track submodules latest commits on defined branch.", "type": "boolean", "default": false, "x-nullable": true}, "scm_delete_on_update": {"title": "Scm delete on update", "description": "Delete the project before syncing.", "type": "boolean", "default": false, "x-nullable": true}, "credential": {"title": "Credential", "type": "integer", "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) to run before the task is canceled.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "scm_revision": {"title": "SCM Revision", "description": "The SCM Revision discovered by this update for the given project and branch.", "type": "string", "readOnly": true, "minLength": 1}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "project": {"title": "Project", "type": "string", "readOnly": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "default": "check", "x-nullable": true}, "job_tags": {"title": "Job tags", "description": "Parts of the project update playbook that will be run.", "type": "string", "default": "", "maxLength": 1024, "x-nullable": true}, "host_status_counts": {"title": "Host status counts", "description": "Playbook stats from the Ansible playbook_on_stats event.", "type": "object", "readOnly": true, "x-nullable": true}, "playbook_counts": {"title": "Playbook counts", "description": "A count of all plays and tasks for the job run.", "type": "string", "readOnly": true}}}, "ProjectUpdateCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}, "ProjectUpdateEvent": {"required": ["event"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "event": {"title": "Event", "type": "string", "enum": ["runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error"], "x-nullable": true}, "counter": {"title": "Counter", "type": "integer", "readOnly": true, "minimum": 0}, "event_display": {"title": "Event display", "type": "string", "readOnly": true, "minLength": 1}, "event_data": {"title": "Event data", "type": "string", "readOnly": true}, "event_level": {"title": "Event level", "type": "integer", "readOnly": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "changed": {"title": "Changed", "type": "boolean", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1}, "host_name": {"title": "Host name", "type": "string", "readOnly": true}, "playbook": {"title": "Playbook", "type": "string", "readOnly": true, "minLength": 1}, "play": {"title": "Play", "type": "string", "readOnly": true, "minLength": 1}, "task": {"title": "Task", "type": "string", "readOnly": true, "minLength": 1}, "role": {"title": "Role", "type": "string", "readOnly": true, "minLength": 1}, "stdout": {"title": "Stdout", "type": "string", "readOnly": true}, "start_line": {"title": "Start line", "type": "integer", "readOnly": true, "minimum": 0}, "end_line": {"title": "End line", "type": "integer", "readOnly": true, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "readOnly": true, "minimum": 0}, "project_update": {"title": "Project update", "type": "string", "readOnly": true}}}, "ProjectInventories": {"type": "object", "properties": {"inventory_files": {"title": "Inventory files", "description": "Array of inventory files and directories available within this project, not comprehensive.", "type": "string", "readOnly": true}}}, "ProjectPlaybooks": {"type": "object", "properties": {"playbooks": {"title": "Playbooks", "description": "Array of playbooks available within this project.", "type": "string", "readOnly": true}}}, "ProjectUpdateView": {"type": "object", "properties": {"can_update": {"title": "Can update", "type": "boolean", "readOnly": true}}}, "SchedulePreview": {"required": ["rrule"], "type": "object", "properties": {"rrule": {"title": "Rrule", "description": "A value representing the schedules iCal recurrence rule.", "type": "string", "minLength": 1, "x-nullable": true}}}, "SettingCategory": {"type": "object", "properties": {"url": {"title": "Url", "type": "string", "readOnly": true, "minLength": 1}, "slug": {"title": "Slug", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "type": "string", "readOnly": true, "minLength": 1}}}, "SettingSingleton": {"required": ["ACTIVITY_STREAM_ENABLED", "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC", "ORG_ADMINS_CAN_SEE_ALL_USERS", "MANAGE_ORGANIZATION_AUTH", "TOWER_URL_BASE", "REMOTE_HOST_HEADERS", "ALLOW_JINJA_IN_EXTRA_VARS", "AWX_ISOLATION_BASE_PATH", "AWX_RUNNER_KEEPALIVE_SECONDS", "GALAXY_TASK_ENV", "PROJECT_UPDATE_VVV", "STDOUT_MAX_BYTES_DISPLAY", "EVENT_STDOUT_MAX_BYTES_DISPLAY", "SCHEDULE_MAX_JOBS", "CLEANUP_HOST_METRICS_LAST_TS", "HOST_METRIC_SUMMARY_TASK_LAST_TS", "SESSION_COOKIE_AGE", "SESSIONS_PER_USER", "DISABLE_LOCAL_AUTH", "AUTH_BASIC_ENABLED", "MAX_UI_JOB_EVENTS", "UI_LIVE_UPDATES_ENABLED", "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT", "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY", "SOCIAL_AUTH_SAML_ORG_INFO", "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT", "SOCIAL_AUTH_SAML_SUPPORT_CONTACT"], "type": "object", "properties": {"ACTIVITY_STREAM_ENABLED": {"title": "Enable Activity Stream", "description": "Enable capturing activity for the activity stream.", "type": "boolean", "default": true}, "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC": {"title": "Enable Activity Stream for Inventory Sync", "description": "Enable capturing activity for the activity stream when running inventory sync.", "type": "boolean", "default": false}, "ORG_ADMINS_CAN_SEE_ALL_USERS": {"title": "All Users Visible to Organization Admins", "description": "Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization.", "type": "boolean", "default": true}, "MANAGE_ORGANIZATION_AUTH": {"title": "Organization Admins Can Manage Users and Teams", "description": "Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration.", "type": "boolean", "default": true}, "TOWER_URL_BASE": {"title": "Base URL of the service", "description": "This setting is used by services like notifications to render a valid url to the service.", "type": "string", "default": "https://platformhost", "minLength": 1}, "REMOTE_HOST_HEADERS": {"description": "HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if behind a reverse proxy. See the \"Proxy Support\" section of the AAP Installation guide for more details.", "type": "array", "items": {"type": "string", "minLength": 1}, "default": ["REMOTE_ADDR", "REMOTE_HOST"]}, "PROXY_IP_ALLOWED_LIST": {"description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "CSRF_TRUSTED_ORIGINS": {"description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. ", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "LICENSE": {"title": "License", "description": "The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "readOnly": true, "default": {}}, "REDHAT_USERNAME": {"title": "Red Hat customer username", "description": "This username is used to send data to Automation Analytics", "type": "string", "default": ""}, "REDHAT_PASSWORD": {"title": "Red Hat customer password", "description": "This password is used to send data to Automation Analytics", "type": "string", "default": ""}, "SUBSCRIPTIONS_USERNAME": {"title": "Red Hat or Satellite username", "description": "This username is used to retrieve subscription and content information", "type": "string", "default": ""}, "SUBSCRIPTIONS_PASSWORD": {"title": "Red Hat or Satellite password", "description": "This password is used to retrieve subscription and content information", "type": "string", "default": ""}, "AUTOMATION_ANALYTICS_URL": {"title": "Automation Analytics upload URL", "description": "This setting is used to to configure the upload URL for data collection for Automation Analytics.", "type": "string", "default": "https://example.com", "minLength": 1}, "INSTALL_UUID": {"title": "Unique identifier for an installation", "type": "string", "readOnly": true, "default": "00000000-0000-0000-0000-000000000000", "minLength": 1}, "DEFAULT_CONTROL_PLANE_QUEUE_NAME": {"title": "The instance group where control plane tasks run", "type": "string", "readOnly": true, "default": "controlplane", "minLength": 1}, "DEFAULT_EXECUTION_QUEUE_NAME": {"title": "The instance group where user jobs run (currently only on non-VM installs)", "type": "string", "readOnly": true, "default": "default", "minLength": 1}, "DEFAULT_EXECUTION_ENVIRONMENT": {"title": "Global default execution environment", "description": "The Execution Environment to be used when one has not been configured for a job template.", "type": "integer", "x-nullable": true}, "CUSTOM_VENV_PATHS": {"description": "Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line.", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "AD_HOC_COMMANDS": {"description": "List of modules allowed to be used by ad-hoc jobs.", "type": "array", "items": {"type": "string", "minLength": 1}, "default": ["command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user"]}, "ALLOW_JINJA_IN_EXTRA_VARS": {"title": "When can extra variables contain Jinja templates?", "description": "Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to \"template\" or \"never\".", "type": "string", "enum": ["always", "never", "template"], "default": "template"}, "AWX_ISOLATION_BASE_PATH": {"title": "Job execution path", "description": "The directory in which the service will create new temporary directories for job execution and isolation (such as credential files).", "type": "string", "default": "/tmp", "minLength": 1}, "AWX_ISOLATION_SHOW_PATHS": {"description": "List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. ", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "AWX_TASK_ENV": {"title": "Extra Environment Variables", "description": "Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AWX_RUNNER_KEEPALIVE_SECONDS": {"title": "K8S Ansible Runner Keep-Alive Message Interval", "description": "Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open.", "type": "integer", "default": 0}, "GALAXY_TASK_ENV": {"title": "Environment Variables for Galaxy Commands", "description": "Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {"ANSIBLE_FORCE_COLOR": "false", "GIT_SSH_COMMAND": "ssh -o StrictHostKeyChecking=no"}}, "INSIGHTS_TRACKING_STATE": {"title": "Gather data for Automation Analytics", "description": "Enables the service to gather data on automation and send it to Automation Analytics.", "type": "boolean", "default": false}, "PROJECT_UPDATE_VVV": {"title": "Run Project Updates With Higher Verbosity", "description": "Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates.", "type": "boolean", "default": false}, "AWX_ROLES_ENABLED": {"title": "Enable Role Download", "description": "Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects.", "type": "boolean", "default": true}, "AWX_COLLECTIONS_ENABLED": {"title": "Enable Collection(s) Download", "description": "Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects.", "type": "boolean", "default": true}, "AWX_SHOW_PLAYBOOK_LINKS": {"title": "Follow symlinks", "description": "Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself.", "type": "boolean", "default": false}, "AWX_MOUNT_ISOLATED_PATHS_ON_K8S": {"title": "Expose host paths for Container Groups", "description": "Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. ", "type": "boolean", "default": false}, "GALAXY_IGNORE_CERTS": {"title": "Ignore Ansible Galaxy SSL Certificate Verification", "description": "If set to true, certificate validation will not be done when installing content from any Galaxy server.", "type": "boolean", "default": false}, "STDOUT_MAX_BYTES_DISPLAY": {"title": "Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display before requiring the output be downloaded.", "type": "integer", "default": 1048576, "minimum": 0}, "EVENT_STDOUT_MAX_BYTES_DISPLAY": {"title": "Job Event Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated.", "type": "integer", "default": 1024, "minimum": 0}, "MAX_WEBSOCKET_EVENT_RATE": {"title": "Job Event Maximum Websocket Messages Per Second", "description": "Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit.", "type": "integer", "default": 30, "minimum": 0}, "SCHEDULE_MAX_JOBS": {"title": "Maximum Scheduled Jobs", "description": "Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created.", "type": "integer", "default": 10, "minimum": 1}, "AWX_ANSIBLE_CALLBACK_PLUGINS": {"description": "List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line.", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "DEFAULT_JOB_TIMEOUT": {"title": "Default Job Timeout", "description": "Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this.", "type": "integer", "default": 0, "minimum": 0}, "DEFAULT_JOB_IDLE_TIMEOUT": {"title": "Default Job Idle Timeout", "description": "If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed.", "type": "integer", "default": 0, "minimum": 0}, "DEFAULT_INVENTORY_UPDATE_TIMEOUT": {"title": "Default Inventory Update Timeout", "description": "Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this.", "type": "integer", "default": 0, "minimum": 0}, "DEFAULT_PROJECT_UPDATE_TIMEOUT": {"title": "Default Project Update Timeout", "description": "Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this.", "type": "integer", "default": 0, "minimum": 0}, "ANSIBLE_FACT_CACHE_TIMEOUT": {"title": "Per-Host Ansible Fact Cache Timeout", "description": "Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed.", "type": "integer", "default": 0, "minimum": 0}, "MAX_FORKS": {"title": "Maximum number of forks per job", "description": "Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied.", "type": "integer", "default": 200}, "LOG_AGGREGATOR_HOST": {"title": "Logging Aggregator", "description": "Hostname/IP where external logs will be sent to.", "type": "string", "minLength": 1, "x-nullable": true}, "LOG_AGGREGATOR_PORT": {"title": "Logging Aggregator Port", "description": "Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator).", "type": "integer", "x-nullable": true}, "LOG_AGGREGATOR_TYPE": {"title": "Logging Aggregator Type", "description": "Format messages for the chosen log aggregator.", "type": "string", "enum": ["logstash", "splunk", "loggly", "sumologic", "other"], "x-nullable": true}, "LOG_AGGREGATOR_USERNAME": {"title": "Logging Aggregator Username", "description": "Username for external log aggregator (if required; HTTP/s only).", "type": "string", "default": ""}, "LOG_AGGREGATOR_PASSWORD": {"title": "Logging Aggregator Password/Token", "description": "Password or authentication token for external log aggregator (if required; HTTP/s only).", "type": "string", "default": ""}, "LOG_AGGREGATOR_LOGGERS": {"description": "List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n", "type": "array", "items": {"type": "string", "minLength": 1}, "default": ["awx", "activity_stream", "job_events", "system_tracking", "broadcast_websocket"]}, "LOG_AGGREGATOR_INDIVIDUAL_FACTS": {"title": "Log System Tracking Facts Individually", "description": "If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing.", "type": "boolean", "default": false}, "LOG_AGGREGATOR_ENABLED": {"title": "Enable External Logging", "description": "Enable sending logs to external log aggregator.", "type": "boolean", "default": false}, "LOG_AGGREGATOR_TOWER_UUID": {"title": "Cluster-wide unique identifier.", "description": "Useful to uniquely identify instances.", "type": "string", "default": ""}, "LOG_AGGREGATOR_PROTOCOL": {"title": "Logging Aggregator Protocol", "description": "Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.", "type": "string", "enum": ["https", "tcp", "udp"], "default": "https"}, "LOG_AGGREGATOR_TCP_TIMEOUT": {"title": "TCP Connection Timeout", "description": "Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols.", "type": "integer", "default": 5}, "LOG_AGGREGATOR_VERIFY_CERT": {"title": "Enable/disable HTTPS certificate verification", "description": "Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection.", "type": "boolean", "default": true}, "LOG_AGGREGATOR_LEVEL": {"title": "Logging Aggregator Level Threshold", "description": "Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting)", "type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], "default": "INFO"}, "LOG_AGGREGATOR_ACTION_QUEUE_SIZE": {"title": "Maximum number of messages that can be stored in the log action queue", "description": "Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5).", "type": "integer", "default": 131072, "minimum": 1}, "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB": {"title": "Maximum disk persistence for rsyslogd action queuing (in GB)", "description": "Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH.", "type": "integer", "default": 1, "minimum": 1}, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH": {"title": "File system location for rsyslogd disk persistence", "description": "Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting.", "type": "string", "default": "/var/lib/awx", "minLength": 1}, "LOG_AGGREGATOR_RSYSLOGD_DEBUG": {"title": "Enable rsyslogd debugging", "description": "Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation.", "type": "boolean", "default": false}, "API_400_ERROR_LOG_FORMAT": {"title": "Log Format For API 4XX Errors", "description": "The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}.", "type": "string", "default": "status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", "minLength": 1}, "AUTOMATION_ANALYTICS_LAST_GATHER": {"title": "Last gather date for Automation Analytics.", "type": "string", "format": "date-time", "x-nullable": true}, "AUTOMATION_ANALYTICS_LAST_ENTRIES": {"title": "Last gathered entries from the data collection service of Automation Analytics", "type": "string", "default": ""}, "AUTOMATION_ANALYTICS_GATHER_INTERVAL": {"title": "Automation Analytics Gather Interval", "description": "Interval (in seconds) between data gathering.", "type": "integer", "default": 14400, "minimum": 1800}, "IS_K8S": {"title": "Is k8s", "description": "Indicates whether the instance is part of a kubernetes-based deployment.", "type": "boolean", "readOnly": true, "default": false}, "BULK_JOB_MAX_LAUNCH": {"title": "Max jobs to allow bulk jobs to launch", "description": "Max jobs to allow bulk jobs to launch", "type": "integer", "default": 100}, "BULK_HOST_MAX_CREATE": {"title": "Max number of hosts to allow to be created in a single bulk action", "description": "Max number of hosts to allow to be created in a single bulk action", "type": "integer", "default": 100}, "BULK_HOST_MAX_DELETE": {"title": "Max number of hosts to allow to be deleted in a single bulk action", "description": "Max number of hosts to allow to be deleted in a single bulk action", "type": "integer", "default": 250}, "UI_NEXT": {"title": "Enable Preview of New User Interface", "description": "Enable preview of new user interface.", "type": "boolean", "default": true}, "SUBSCRIPTION_USAGE_MODEL": {"title": "Defines subscription usage model and shows Host Metrics", "type": "string", "enum": ["", "unique_managed_hosts"], "default": ""}, "CLEANUP_HOST_METRICS_LAST_TS": {"title": "Last cleanup date for HostMetrics", "type": "string", "format": "date-time", "x-nullable": true}, "HOST_METRIC_SUMMARY_TASK_LAST_TS": {"title": "Last computing date of HostMetricSummaryMonthly", "type": "string", "format": "date-time", "x-nullable": true}, "AWX_CLEANUP_PATHS": {"title": "Enable or Disable tmp dir cleanup", "description": "Enable or Disable TMP Dir cleanup", "type": "boolean", "default": true}, "AWX_REQUEST_PROFILE": {"title": "Debug Web Requests", "description": "Debug web request python timing", "type": "boolean", "default": false}, "DEFAULT_CONTAINER_RUN_OPTIONS": {"description": "List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']", "type": "array", "items": {"type": "string", "minLength": 1}, "default": ["--network", "slirp4netns:enable_ipv6=true"]}, "RECEPTOR_RELEASE_WORK": {"title": "Release Receptor Work", "description": "Release receptor work", "type": "boolean", "default": true}, "RECEPTOR_KEEP_WORK_ON_ERROR": {"title": "Keep receptor work on error", "description": "Prevent receptor work from being released on when error is detected", "type": "boolean", "default": false}, "SESSION_COOKIE_AGE": {"title": "Idle Time Force Log Out", "description": "Number of seconds that a user is inactive before they will need to login again.", "type": "integer", "default": 1800, "maximum": 30000000000, "minimum": 60}, "SESSIONS_PER_USER": {"title": "Maximum number of simultaneous logged in sessions", "description": "Maximum number of simultaneous logged in sessions a user may have. To disable enter -1.", "type": "integer", "default": -1, "minimum": -1}, "DISABLE_LOCAL_AUTH": {"title": "Disable the built-in authentication system", "description": "Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration.", "type": "boolean", "default": false}, "AUTH_BASIC_ENABLED": {"title": "Enable HTTP Basic Auth", "description": "Enable HTTP Basic Auth for the API Browser.", "type": "boolean", "default": true}, "OAUTH2_PROVIDER": {"title": "OAuth 2 Timeout Settings", "description": "Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds.", "type": "object", "additionalProperties": {"type": "integer", "minimum": 1}, "default": {"ACCESS_TOKEN_EXPIRE_SECONDS": 31536000000, "AUTHORIZATION_CODE_EXPIRE_SECONDS": 600, "REFRESH_TOKEN_EXPIRE_SECONDS": 2628000}}, "ALLOW_OAUTH2_FOR_EXTERNAL_USERS": {"title": "Allow External Users to Create OAuth2 Tokens", "description": "For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off.", "type": "boolean", "default": false}, "LOGIN_REDIRECT_OVERRIDE": {"title": "Login redirect override URL", "description": "URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page.", "type": "string", "default": ""}, "ALLOW_METRICS_FOR_ANONYMOUS_USERS": {"title": "Allow anonymous users to poll metrics", "description": "If true, anonymous users are allowed to poll metrics.", "type": "boolean", "default": false}, "PENDO_TRACKING_STATE": {"title": "User Analytics Tracking State", "description": "Enable or Disable User Analytics Tracking.", "type": "string", "enum": ["off", "anonymous", "detailed"], "readOnly": true, "default": "off"}, "CUSTOM_LOGIN_INFO": {"title": "Custom Login Info", "description": "If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported.", "type": "string", "default": ""}, "CUSTOM_LOGO": {"title": "Custom Logo", "description": "To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported.", "type": "string", "default": ""}, "MAX_UI_JOB_EVENTS": {"title": "Max Job Events Retrieved by UI", "description": "Maximum number of job events for the UI to retrieve within a single request.", "type": "integer", "default": 4000, "minimum": 100}, "UI_LIVE_UPDATES_ENABLED": {"title": "Enable Live Updates in the UI", "description": "If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details.", "type": "boolean", "default": true}, "AUTHENTICATION_BACKENDS": {"description": "List of authentication backends that are enabled based on license features and other authentication settings.", "type": "array", "items": {"type": "string", "minLength": 1}, "readOnly": true, "default": ["awx.sso.backends.TACACSPlusBackend", "awx.main.backends.AWXModelBackend"]}, "SOCIAL_AUTH_ORGANIZATION_MAP": {"title": "Social Auth Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_TEAM_MAP": {"title": "Social Auth Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_USER_FIELDS": {"description": "When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login.", "type": "array", "items": {"type": "string", "minLength": 1}, "x-nullable": true}, "SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL": {"title": "Use Email address for usernames", "description": "Enabling this setting will tell social auth to use the full Email as username instead of the full name", "type": "boolean", "default": false}, "AUTH_LDAP_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_1_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_1_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_1_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_1_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_1_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_1_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_1_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_1_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_1_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_1_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_1_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_1_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_1_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_1_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_1_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_1_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_2_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_2_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_2_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_2_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_2_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_2_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_2_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_2_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_2_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_2_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_2_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_2_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_2_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_2_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_2_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_2_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_3_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_3_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_3_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_3_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_3_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_3_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_3_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_3_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_3_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_3_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_3_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_3_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_3_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_3_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_3_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_3_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_4_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_4_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_4_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_4_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_4_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_4_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_4_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_4_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_4_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_4_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_4_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_4_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_4_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_4_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_4_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_4_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_5_SERVER_URI": {"title": "LDAP Server URI", "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", "type": "string", "default": ""}, "AUTH_LDAP_5_BIND_DN": {"title": "LDAP Bind DN", "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", "type": "string", "default": ""}, "AUTH_LDAP_5_BIND_PASSWORD": {"title": "LDAP Bind Password", "description": "Password used to bind LDAP user account.", "type": "string", "default": ""}, "AUTH_LDAP_5_START_TLS": {"title": "LDAP Start TLS", "description": "Whether to enable TLS when the LDAP connection is not using SSL.", "type": "boolean", "default": false}, "AUTH_LDAP_5_CONNECTION_OPTIONS": {"title": "LDAP Connection Options", "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30}}, "AUTH_LDAP_5_USER_SEARCH": {"description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_5_USER_DN_TEMPLATE": {"title": "LDAP User DN Template", "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", "type": "string", "x-nullable": true}, "AUTH_LDAP_5_USER_ATTR_MAP": {"title": "LDAP User Attribute Map", "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}, "default": {}}, "AUTH_LDAP_5_GROUP_SEARCH": {"description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", "type": "array", "items": {"type": "string", "x-nullable": true}, "default": []}, "AUTH_LDAP_5_GROUP_TYPE": {"title": "LDAP Group Type", "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", "type": "string", "enum": ["PosixGroupType", "GroupOfNamesType", "GroupOfUniqueNamesType", "ActiveDirectoryGroupType", "OrganizationalRoleGroupType", "MemberDNGroupType", "NestedGroupOfNamesType", "NestedGroupOfUniqueNamesType", "NestedActiveDirectoryGroupType", "NestedOrganizationalRoleGroupType", "NestedMemberDNGroupType", "PosixUIDGroupType"], "default": "MemberDNGroupType"}, "AUTH_LDAP_5_GROUP_TYPE_PARAMS": {"title": "LDAP Group Type Parameters", "description": "Key value parameters to send the chosen group type init method.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"member_attr": "member", "name_attr": "cn"}}, "AUTH_LDAP_5_REQUIRE_GROUP": {"title": "LDAP Require Group", "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_5_DENY_GROUP": {"title": "LDAP Deny Group", "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", "type": "string", "x-nullable": true}, "AUTH_LDAP_5_USER_FLAGS_BY_GROUP": {"title": "LDAP User Flags By Group", "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string", "minLength": 1}}, "default": {}}, "AUTH_LDAP_5_ORGANIZATION_MAP": {"title": "LDAP Organization Map", "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "AUTH_LDAP_5_TEAM_MAP": {"title": "LDAP Team Map", "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "default": {}}, "RADIUS_SERVER": {"title": "RADIUS Server", "description": "Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty.", "type": "string", "default": ""}, "RADIUS_PORT": {"title": "RADIUS Port", "description": "Port of RADIUS server.", "type": "integer", "default": 1812, "maximum": 65535, "minimum": 1}, "RADIUS_SECRET": {"title": "RADIUS Secret", "description": "Shared secret for authenticating to RADIUS server.", "type": "string", "default": ""}, "TACACSPLUS_HOST": {"title": "TACACS+ Server", "description": "Hostname of TACACS+ server.", "type": "string", "default": ""}, "TACACSPLUS_PORT": {"title": "TACACS+ Port", "description": "Port number of TACACS+ server.", "type": "integer", "default": 49, "maximum": 65535, "minimum": 1}, "TACACSPLUS_SECRET": {"title": "TACACS+ Secret", "description": "Shared secret for authenticating to TACACS+ server.", "type": "string", "default": ""}, "TACACSPLUS_SESSION_TIMEOUT": {"title": "TACACS+ Auth Session Timeout", "description": "TACACS+ session timeout value in seconds, 0 disables timeout.", "type": "integer", "default": 5, "minimum": 0}, "TACACSPLUS_AUTH_PROTOCOL": {"title": "TACACS+ Authentication Protocol", "description": "Choose the authentication protocol used by TACACS+ client.", "type": "string", "enum": ["ascii", "pap"], "default": "ascii"}, "TACACSPLUS_REM_ADDR": {"title": "TACACS+ client address sending enabled", "description": "Enable the client address sending by TACACS+ client.", "type": "boolean", "default": false}, "SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL": {"title": "Google OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/google-oauth2/", "minLength": 1}, "SOCIAL_AUTH_GOOGLE_OAUTH2_KEY": {"title": "Google OAuth2 Key", "description": "The OAuth2 key from your web application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET": {"title": "Google OAuth2 Secret", "description": "The OAuth2 secret from your web application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS": {"description": "Update this setting to restrict the domains who are allowed to login using Google OAuth2.", "type": "array", "items": {"type": "string", "minLength": 1}, "default": []}, "SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS": {"title": "Google OAuth2 Extra Arguments", "description": "Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {}}, "SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP": {"title": "Google OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP": {"title": "Google OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_CALLBACK_URL": {"title": "GitHub OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_KEY": {"title": "GitHub OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub developer application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_SECRET": {"title": "GitHub OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub developer application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP": {"title": "GitHub OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_TEAM_MAP": {"title": "GitHub OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL": {"title": "GitHub Organization OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github-org/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_ORG_KEY": {"title": "GitHub Organization OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ORG_SECRET": {"title": "GitHub Organization OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ORG_NAME": {"title": "GitHub Organization Name", "description": "The name of your GitHub organization, as used in your organization's URL: https://github.com//.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP": {"title": "GitHub Organization OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP": {"title": "GitHub Organization OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL": {"title": "GitHub Team OAuth2 Callback URL", "description": "Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github-team/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_TEAM_KEY": {"title": "GitHub Team OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_TEAM_SECRET": {"title": "GitHub Team OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_TEAM_ID": {"title": "GitHub Team ID", "description": "Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP": {"title": "GitHub Team OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP": {"title": "GitHub Team OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL": {"title": "GitHub Enterprise OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github-enterprise/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_URL": {"title": "GitHub Enterprise URL", "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL": {"title": "GitHub Enterprise API URL", "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY": {"title": "GitHub Enterprise OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub Enterprise developer application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET": {"title": "GitHub Enterprise OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP": {"title": "GitHub Enterprise OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP": {"title": "GitHub Enterprise OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL": {"title": "GitHub Enterprise Organization OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github-enterprise-org/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL": {"title": "GitHub Enterprise Organization URL", "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL": {"title": "GitHub Enterprise Organization API URL", "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY": {"title": "GitHub Enterprise Organization OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET": {"title": "GitHub Enterprise Organization OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME": {"title": "GitHub Enterprise Organization Name", "description": "The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com//.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP": {"title": "GitHub Enterprise Organization OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP": {"title": "GitHub Enterprise Organization OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL": {"title": "GitHub Enterprise Team OAuth2 Callback URL", "description": "Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/github-enterprise-team/", "minLength": 1}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL": {"title": "GitHub Enterprise Team URL", "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL": {"title": "GitHub Enterprise Team API URL", "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY": {"title": "GitHub Enterprise Team OAuth2 Key", "description": "The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET": {"title": "GitHub Enterprise Team OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID": {"title": "GitHub Enterprise Team ID", "description": "Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", "type": "string", "default": ""}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP": {"title": "GitHub Enterprise Team OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP": {"title": "GitHub Enterprise Team OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL": {"title": "Azure AD OAuth2 Callback URL", "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. ", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/azuread-oauth2/", "minLength": 1}, "SOCIAL_AUTH_AZUREAD_OAUTH2_KEY": {"title": "Azure AD OAuth2 Key", "description": "The OAuth2 key (Client ID) from your Azure AD application.", "type": "string", "default": ""}, "SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET": {"title": "Azure AD OAuth2 Secret", "description": "The OAuth2 secret (Client Secret) from your Azure AD application.", "type": "string", "default": ""}, "SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP": {"title": "Azure AD OAuth2 Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP": {"title": "Azure AD OAuth2 Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_OIDC_KEY": {"title": "OIDC Key", "description": "The OIDC key (Client ID) from your IDP.", "type": "string", "minLength": 1}, "SOCIAL_AUTH_OIDC_SECRET": {"title": "OIDC Secret", "description": "The OIDC secret (Client Secret) from your IDP.", "type": "string", "default": ""}, "SOCIAL_AUTH_OIDC_OIDC_ENDPOINT": {"title": "OIDC Provider URL", "description": "The URL for your OIDC provider including the path up to /.well-known/openid-configuration", "type": "string", "default": ""}, "SOCIAL_AUTH_OIDC_VERIFY_SSL": {"title": "Verify OIDC Provider Certificate", "description": "Verify the OIDC provider ssl certificate.", "type": "boolean", "default": true}, "SAML_AUTO_CREATE_OBJECTS": {"title": "Automatically Create Organizations and Teams on SAML Login", "description": "When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login.", "type": "boolean", "default": true}, "SOCIAL_AUTH_SAML_CALLBACK_URL": {"title": "SAML Assertion Consumer Service (ACS) URL", "description": "Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/complete/saml/", "minLength": 1}, "SOCIAL_AUTH_SAML_METADATA_URL": {"title": "SAML Service Provider Metadata URL", "description": "If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL.", "type": "string", "readOnly": true, "default": "https://platformhost/sso/metadata/saml/", "minLength": 1}, "SOCIAL_AUTH_SAML_SP_ENTITY_ID": {"title": "SAML Service Provider Entity ID", "description": "The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service.", "type": "string", "default": ""}, "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT": {"title": "SAML Service Provider Public Certificate", "description": "Create a keypair to use as a service provider (SP) and include the certificate content here.", "type": "string", "default": ""}, "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY": {"title": "SAML Service Provider Private Key", "description": "Create a keypair to use as a service provider (SP) and include the private key content here.", "type": "string", "default": ""}, "SOCIAL_AUTH_SAML_ORG_INFO": {"title": "SAML Service Provider Organization Info", "description": "Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string", "x-nullable": true}}, "default": {}}, "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT": {"title": "SAML Service Provider Technical Contact", "description": "Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {}}, "SOCIAL_AUTH_SAML_SUPPORT_CONTACT": {"title": "SAML Service Provider Support Contact", "description": "Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {}}, "SOCIAL_AUTH_SAML_ENABLED_IDPS": {"title": "SAML Enabled Identity Providers", "description": "Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string", "x-nullable": true}}, "default": {}}, "SOCIAL_AUTH_SAML_SECURITY_CONFIG": {"title": "SAML Security Config", "description": "A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "default": {"requestedAuthnContext": false}, "x-nullable": true}, "SOCIAL_AUTH_SAML_SP_EXTRA": {"title": "SAML Service Provider extra configuration data", "description": "A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "x-nullable": true}, "SOCIAL_AUTH_SAML_EXTRA_DATA": {"description": "A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value.", "type": "array", "items": {"type": "string", "x-nullable": true}, "x-nullable": true}, "SOCIAL_AUTH_SAML_ORGANIZATION_MAP": {"title": "SAML Organization Map", "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_SAML_TEAM_MAP": {"title": "SAML Team Map", "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-nullable": true}, "SOCIAL_AUTH_SAML_ORGANIZATION_ATTR": {"title": "SAML Organization Attribute Mapping", "description": "Used to translate user organization membership.", "type": "object", "additionalProperties": {"type": "string"}, "default": {}, "x-nullable": true}, "SOCIAL_AUTH_SAML_TEAM_ATTR": {"title": "SAML Team Attribute Mapping", "description": "Used to translate user team membership.", "type": "object", "additionalProperties": {"type": "string"}, "default": {}, "x-nullable": true}, "SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR": {"title": "SAML User Flags Attribute Mapping", "description": "Used to map super users and system auditors from SAML.", "type": "object", "additionalProperties": {"type": "string"}, "default": {}, "x-nullable": true}, "LOCAL_PASSWORD_MIN_LENGTH": {"title": "Minimum number of characters in local password", "description": "Minimum number of characters required in a local password. 0 means no minimum", "type": "integer", "default": 0, "minimum": 0}, "LOCAL_PASSWORD_MIN_DIGITS": {"title": "Minimum number of digit characters in local password", "description": "Minimum number of digit characters required in a local password. 0 means no minimum", "type": "integer", "default": 0, "minimum": 0}, "LOCAL_PASSWORD_MIN_UPPER": {"title": "Minimum number of uppercase characters in local password", "description": "Minimum number of uppercase characters required in a local password. 0 means no minimum", "type": "integer", "default": 0, "minimum": 0}, "LOCAL_PASSWORD_MIN_SPECIAL": {"title": "Minimum number of special characters in local password", "description": "Minimum number of special characters required in a local password. 0 means no minimum", "type": "integer", "default": 0, "minimum": 0}, "NAMED_URL_FORMATS": {"title": "Formats of all available named urls", "description": "Read-only list of key-value pairs that shows the standard format of all available named URLs.", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "readOnly": true, "default": {"execution_environments": "", "organizations": "", "teams": "++", "credential_types": "+", "credentials": "+++++", "notification_templates": "++", "job_templates": "++", "projects": "++", "inventories": "++", "hosts": "++++", "groups": "++++", "inventory_sources": "++++", "instance_groups": "", "workflow_job_templates": "++", "workflow_job_template_nodes": "++++", "labels": "++", "applications": "++", "users": "", "instances": ""}}, "NAMED_URL_GRAPH_NODES": {"title": "List of all named url graph nodes.", "description": "Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources", "type": "object", "additionalProperties": {"type": "string", "x-nullable": true}, "readOnly": true, "default": {"execution_environments": {"fields": ["name"], "adj_list": []}, "organizations": {"fields": ["name"], "adj_list": []}, "teams": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "credential_types": {"fields": ["name", "kind"], "adj_list": []}, "credentials": {"fields": ["name"], "adj_list": [["credential_type", "credential_types"], ["organization", "organizations"]]}, "notification_templates": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "job_templates": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "projects": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "inventories": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "hosts": {"fields": ["name"], "adj_list": [["inventory", "inventories"]]}, "groups": {"fields": ["name"], "adj_list": [["inventory", "inventories"]]}, "inventory_sources": {"fields": ["name"], "adj_list": [["inventory", "inventories"]]}, "instance_groups": {"fields": ["name"], "adj_list": []}, "workflow_job_templates": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "workflow_job_template_nodes": {"fields": ["identifier"], "adj_list": [["workflow_job_template", "workflow_job_templates"]]}, "labels": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "applications": {"fields": ["name"], "adj_list": [["organization", "organizations"]]}, "users": {"fields": ["username"], "adj_list": []}, "instances": {"fields": ["hostname"], "adj_list": []}}}}}, "SystemJobTemplate": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens"], "default": "", "x-nullable": true}}}, "SystemJobList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "system_job_template": {"title": "System job template", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens"], "default": "", "x-nullable": true}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "result_stdout": {"title": "Result stdout", "type": "string", "readOnly": true}}}, "SystemJob": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "execution_node": {"title": "Execution node", "description": "The node the job executed on.", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "system_job_template": {"title": "System job template", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens"], "default": "", "x-nullable": true}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "result_stdout": {"title": "Result stdout", "type": "string", "readOnly": true}}}, "SystemJobCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}, "SystemJobEvent": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "event": {"title": "Event", "type": "string", "readOnly": true}, "counter": {"title": "Counter", "type": "integer", "readOnly": true, "minimum": 0}, "event_display": {"title": "Event display", "type": "string", "readOnly": true, "minLength": 1}, "event_data": {"title": "Event data", "type": "object", "default": {}}, "failed": {"title": "Failed", "type": "string", "readOnly": true}, "changed": {"title": "Changed", "type": "string", "readOnly": true}, "uuid": {"title": "Uuid", "type": "string", "readOnly": true, "minLength": 1}, "stdout": {"title": "Stdout", "type": "string", "readOnly": true, "minLength": 1}, "start_line": {"title": "Start line", "type": "integer", "readOnly": true, "minimum": 0}, "end_line": {"title": "End line", "type": "integer", "readOnly": true, "minimum": 0}, "verbosity": {"title": "Verbosity", "type": "integer", "readOnly": true, "minimum": 0}, "system_job": {"title": "System job", "type": "string", "readOnly": true}}}, "TeamCredentialSerializerCreate": {"required": ["name", "credential_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "credential_type": {"title": "Credential Type", "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", "type": "integer"}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "kind": {"title": "Kind", "type": "string", "readOnly": true}, "cloud": {"title": "Cloud", "type": "string", "readOnly": true}, "kubernetes": {"title": "Kubernetes", "type": "string", "readOnly": true}, "team": {"title": "Team", "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", "type": "integer", "x-nullable": true}}}, "RoleSerializerWithParentAccess": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "readOnly": true}}}, "OAuth2TokenDetail": {"type": "object", "properties": {"id": {"title": "Id", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "user": {"title": "User", "description": "The user representing the token owner", "type": "integer", "readOnly": true}, "token": {"title": "Token", "type": "string", "readOnly": true}, "refresh_token": {"title": "Refresh token", "type": "string", "readOnly": true}, "application": {"title": "Application", "type": "integer", "readOnly": true, "x-nullable": true}, "expires": {"title": "Expires", "type": "string", "format": "date-time", "readOnly": true}, "scope": {"title": "Scope", "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "type": "string", "default": "write", "x-nullable": true}}}, "UserAuthorizedToken": {"required": ["application"], "type": "object", "properties": {"id": {"title": "Id", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "user": {"title": "User", "description": "The user representing the token owner", "type": "integer", "readOnly": true}, "token": {"title": "Token", "type": "string", "readOnly": true}, "refresh_token": {"title": "Refresh token", "type": "string", "readOnly": true}, "application": {"title": "Application", "type": "integer"}, "expires": {"title": "Expires", "type": "string", "format": "date-time", "readOnly": true}, "scope": {"title": "Scope", "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "type": "string", "default": "write", "x-nullable": true}}}, "UserCredentialSerializerCreate": {"required": ["name", "credential_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "credential_type": {"title": "Credential Type", "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", "type": "integer"}, "managed": {"title": "Managed", "type": "string", "readOnly": true}, "inputs": {"title": "Inputs", "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", "type": "object", "default": {}}, "kind": {"title": "Kind", "type": "string", "readOnly": true}, "cloud": {"title": "Cloud", "type": "string", "readOnly": true}, "kubernetes": {"title": "Kubernetes", "type": "string", "readOnly": true}, "user": {"title": "User", "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", "type": "integer", "x-nullable": true}}}, "UserPersonalToken": {"type": "object", "properties": {"id": {"title": "Id", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "user": {"title": "User", "description": "The user representing the token owner", "type": "integer", "readOnly": true}, "token": {"title": "Token", "type": "string", "readOnly": true}, "refresh_token": {"title": "Refresh token", "type": "string", "readOnly": true}, "application": {"title": "Application", "type": "integer", "readOnly": true, "x-nullable": true}, "expires": {"title": "Expires", "type": "string", "format": "date-time", "readOnly": true}, "scope": {"title": "Scope", "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", "type": "string", "default": "write", "x-nullable": true}}}, "WorkflowApprovalTemplate": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "last_job_run": {"title": "Last job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "last_job_failed": {"title": "Last job failed", "type": "boolean", "readOnly": true}, "next_job_run": {"title": "Next job run", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "timeout": {"title": "Timeout", "description": "The amount of time (in seconds) before the approval node expires and fails.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}}}, "WorkflowApprovalList": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "can_approve_or_deny": {"title": "Can approve or deny", "type": "string", "readOnly": true}, "approval_expiration": {"title": "Approval expiration", "type": "string", "readOnly": true}, "timed_out": {"title": "Timed out", "type": "string", "readOnly": true}}}, "WorkflowApproval": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "event_processing_finished": {"title": "Event processing finished", "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", "type": "boolean", "readOnly": true}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "can_approve_or_deny": {"title": "Can approve or deny", "type": "string", "readOnly": true}, "approval_expiration": {"title": "Approval expiration", "type": "string", "readOnly": true}, "timed_out": {"title": "Timed out", "type": "string", "readOnly": true}}}, "WorkflowApprovalView": {"type": "object", "properties": {}}, "WorkflowJobNodeList": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "job": {"title": "Job", "type": "integer", "x-nullable": true}, "workflow_job": {"title": "Workflow job", "type": "string", "x-nullable": true}, "unified_job_template": {"title": "Unified job template", "type": "integer", "x-nullable": true}, "success_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "failure_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "always_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "all_parents_must_converge": {"title": "All parents must converge", "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type": "boolean", "default": false, "x-nullable": true}, "do_not_run": {"title": "Do not run", "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", "type": "boolean", "default": false, "x-nullable": true}, "identifier": {"title": "Identifier", "description": "An identifier coresponding to the workflow job template node that this node was created from.", "type": "string", "maxLength": 512, "x-nullable": true}}}, "WorkflowJobNodeDetail": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "job": {"title": "Job", "type": "integer", "x-nullable": true}, "workflow_job": {"title": "Workflow job", "type": "string", "x-nullable": true}, "unified_job_template": {"title": "Unified job template", "type": "integer", "x-nullable": true}, "success_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "failure_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "always_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "all_parents_must_converge": {"title": "All parents must converge", "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type": "boolean", "default": false, "x-nullable": true}, "do_not_run": {"title": "Do not run", "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", "type": "boolean", "default": false, "x-nullable": true}, "identifier": {"title": "Identifier", "description": "An identifier coresponding to the workflow job template node that this node was created from.", "type": "string", "maxLength": 512, "x-nullable": true}}}, "WorkflowJobTemplateNode": {"required": ["workflow_job_template"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "workflow_job_template": {"title": "Workflow job template", "type": "string"}, "unified_job_template": {"title": "Unified job template", "type": "integer", "x-nullable": true}, "success_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "failure_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "always_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "all_parents_must_converge": {"title": "All parents must converge", "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type": "boolean", "default": false, "x-nullable": true}, "identifier": {"title": "Identifier", "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "type": "string", "default": "6f418a03-f6dc-4039-a160-821620a9ae60", "maxLength": 512, "minLength": 1, "x-nullable": true}}}, "WorkflowJobTemplateNodeDetail": {"required": ["workflow_job_template"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "extra_data": {"title": "Extra data", "type": "object", "default": {}}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "job_type": {"title": "Job type", "type": "string", "enum": ["run", "check"], "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "diff_mode": {"title": "Diff mode", "type": "boolean", "x-nullable": true}, "verbosity": {"title": "Verbosity", "type": "string", "enum": [0, 1, 2, 3, 4, 5], "x-nullable": true}, "execution_environment": {"title": "Execution environment", "description": "The container image to be used for execution.", "type": "integer", "x-nullable": true}, "forks": {"title": "Forks", "type": "integer", "minimum": 0, "x-nullable": true}, "job_slice_count": {"title": "Job slice count", "type": "integer", "minimum": 0, "x-nullable": true}, "timeout": {"title": "Timeout", "type": "integer", "x-nullable": true}, "workflow_job_template": {"title": "Workflow job template", "type": "string"}, "unified_job_template": {"title": "Unified job template", "type": "integer", "x-nullable": true}, "success_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "failure_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "always_nodes": {"type": "array", "items": {"type": "integer"}, "readOnly": true, "uniqueItems": true}, "all_parents_must_converge": {"title": "All parents must converge", "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", "type": "boolean", "default": false, "x-nullable": true}, "identifier": {"title": "Identifier", "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "type": "string", "default": "3a6decca-bd2c-465d-bbc4-69082e61955b", "maxLength": 512, "minLength": 1, "x-nullable": true}}}, "WorkflowJobTemplateNodeCreateApproval": {"required": ["name"], "type": "object", "properties": {"timeout": {"title": "Timeout", "description": "The amount of time (in seconds) before the approval node expires and fails.", "type": "integer", "default": 0, "maximum": 2147483647, "minimum": -2147483648}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}}}, "WorkflowJobLaunch": {"type": "object", "properties": {"ask_inventory_on_launch": {"title": "Ask inventory on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_limit_on_launch": {"title": "Ask limit on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_scm_branch_on_launch": {"title": "Ask scm branch on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "can_start_without_user_input": {"title": "Can start without user input", "type": "boolean", "readOnly": true}, "defaults": {"title": "Defaults", "type": "string", "readOnly": true}, "extra_vars": {"title": "Extra vars", "type": "string"}, "inventory": {"title": "Inventory", "type": "integer"}, "limit": {"title": "Limit", "type": "string"}, "scm_branch": {"title": "Scm branch", "type": "string"}, "survey_enabled": {"title": "Survey enabled", "type": "string", "readOnly": true}, "variables_needed_to_start": {"title": "Variables needed to start", "type": "string", "readOnly": true}, "node_templates_missing": {"title": "Node templates missing", "type": "string", "readOnly": true}, "node_prompts_rejected": {"title": "Node prompts rejected", "type": "string", "readOnly": true}, "workflow_job_template_data": {"title": "Workflow job template data", "type": "string", "readOnly": true}, "ask_variables_on_launch": {"title": "Ask variables on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_labels_on_launch": {"title": "Ask labels on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "labels": {"type": "array", "items": {"type": "integer"}, "uniqueItems": true}, "ask_skip_tags_on_launch": {"title": "Ask skip tags on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "ask_tags_on_launch": {"title": "Ask tags on launch", "type": "boolean", "readOnly": true, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string"}, "job_tags": {"title": "Job tags", "type": "string"}}}, "WorkflowJob": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "readOnly": true}, "related": {"title": "Related", "type": "string", "readOnly": true}, "summary_fields": {"title": "Summary fields", "type": "string", "readOnly": true}, "created": {"title": "Created", "type": "string", "readOnly": true}, "modified": {"title": "Modified", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": true}, "description": {"title": "Description", "type": "string", "default": "", "x-nullable": true}, "unified_job_template": {"title": "unified job template", "type": "string", "readOnly": true}, "launch_type": {"title": "Launch type", "type": "string", "enum": ["manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm"], "readOnly": true}, "status": {"title": "Status", "type": "string", "enum": ["new", "pending", "waiting", "running", "successful", "failed", "error", "canceled"], "readOnly": true}, "failed": {"title": "Failed", "type": "boolean", "readOnly": true}, "started": {"title": "Started", "description": "The date and time the job was queued for starting.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "finished": {"title": "Finished", "description": "The date and time the job finished execution.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "canceled_on": {"title": "Canceled on", "description": "The date and time when the cancel request was sent.", "type": "string", "format": "date-time", "readOnly": true, "x-nullable": true}, "elapsed": {"title": "Elapsed", "description": "Elapsed time in seconds that the job ran.", "type": "string", "format": "decimal", "readOnly": true}, "job_args": {"title": "Job args", "type": "string", "readOnly": true, "minLength": 1}, "job_cwd": {"title": "Job cwd", "type": "string", "readOnly": true, "minLength": 1}, "job_env": {"title": "job_env", "type": "object", "readOnly": true}, "job_explanation": {"title": "Job explanation", "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", "type": "string", "readOnly": true, "minLength": 1}, "result_traceback": {"title": "Result traceback", "type": "string", "readOnly": true, "minLength": 1}, "launched_by": {"title": "Launched by", "type": "string", "readOnly": true}, "work_unit_id": {"title": "Work unit id", "description": "The Receptor work unit ID associated with this job.", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "workflow_job_template": {"title": "Workflow job template", "type": "string", "x-nullable": true}, "extra_vars": {"title": "Extra vars", "type": "string", "default": "", "x-nullable": true}, "allow_simultaneous": {"title": "Allow simultaneous", "type": "boolean", "default": false, "x-nullable": true}, "job_template": {"title": "Job template", "description": "If automatically created for a sliced job run, the job template the workflow job was created from.", "type": "string", "x-nullable": true}, "is_sliced_job": {"title": "Is sliced job", "type": "boolean", "default": false, "x-nullable": true}, "inventory": {"title": "Inventory", "description": "Inventory applied as a prompt, assuming job template prompts for inventory", "type": "integer", "x-nullable": true}, "limit": {"title": "Limit", "type": "string", "x-nullable": true}, "scm_branch": {"title": "Scm branch", "type": "string", "x-nullable": true}, "webhook_service": {"title": "Webhook service", "description": "Service that webhook requests will be accepted from", "type": "string", "enum": ["github", "gitlab", "bitbucket_dc"], "x-nullable": true}, "webhook_credential": {"title": "Webhook credential", "description": "Personal Access Token for posting back the status to the service API", "type": "integer", "x-nullable": true}, "webhook_guid": {"title": "Webhook guid", "description": "Unique identifier of the event that triggered this webhook", "type": "string", "maxLength": 128, "x-nullable": true}, "skip_tags": {"title": "Skip tags", "type": "string", "x-nullable": true}, "job_tags": {"title": "Job tags", "type": "string", "x-nullable": true}}}, "WorkflowJobCancel": {"type": "object", "properties": {"can_cancel": {"title": "Can cancel", "type": "boolean", "readOnly": true}}}}} \ No newline at end of file +{ + "swagger": "2.0", + "info": { + "title": "Snippets API", + "description": "Test description", + "termsOfService": "https://www.google.com/policies/terms/", + "contact": { "email": "contact@snippets.local" }, + "license": { "name": "BSD License" }, + "version": "v1" + }, + "host": "localhost:8043", + "schemes": ["https"], + "basePath": "/", + "consumes": ["application/json"], + "produces": ["application/json"], + "securityDefinitions": { "Basic": { "type": "basic" } }, + "security": [{ "Basic": [] }], + "paths": { + "/api/": { + "get": { + "operationId": "api_list", + "description": "List supported API versions", + "parameters": [], + "produces": ["application/json"], + "responses": { + "200": { + "description": "An object with available API", + "schema": { + "type": "object" + } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/debug/": { + "get": { + "operationId": "api_debug_list", + "description": "List of available debug urls", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/debug/dependency_manager/": { + "get": { + "operationId": "api_debug_dependency_manager_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/debug/task_manager/": { + "get": { + "operationId": "api_debug_task_manager_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/debug/workflow_manager/": { + "get": { + "operationId": "api_debug_workflow_manager_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/o/": { + "get": { + "operationId": "api_o_list", + "summary": "# Token Handling using OAuth2", + "description": "This page lists OAuth 2 utility endpoints used for authorization, token refresh and revoke.\nNote endpoints other than `/api/o/authorize/` are not meant to be used in browsers and do not\nsupport HTTP GET. The endpoints here strictly follow\n[RFC specs for OAuth2](https://tools.ietf.org/html/rfc6749), so please use that for detailed\nreference. Note AWX net location default to `http://localhost:8013` in examples:\n\n\n## Create Token for an Application using Authorization code grant type\nGiven an application \"AuthCodeApp\" of grant type `authorization-code`, \nfrom the client app, the user makes a GET to the Authorize endpoint with \n\n* `response_type`\n* `client_id`\n* `redirect_uris`\n* `scope` \n\nAWX will respond with the authorization `code` and `state`\nto the redirect_uri specified in the application. The client application will then make a POST to the\n`api/o/token/` endpoint on AWX with\n\n* `code`\n* `client_id`\n* `client_secret`\n* `grant_type`\n* `redirect_uri`\n\nAWX will respond with the `access_token`, `token_type`, `refresh_token`, and `expires_in`. For more\ninformation on testing this flow, refer to [django-oauth-toolkit](http://django-oauth-toolkit.readthedocs.io/en/latest/tutorial/tutorial_01.html#test-your-authorization-server).\n\n\n## Create Token for an Application using Password grant type\n\nLog in is not required for `password` grant type, so a simple `curl` can be used to acquire a personal access token\nvia `/api/o/token/` with \n\n* `grant_type`: Required to be \"password\"\n* `username`\n* `password`\n* `client_id`: Associated application must have grant_type \"password\"\n* `client_secret`\n\nFor example:\n\n```bash\ncurl -X POST \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=password&username=&password=&scope=read\" \\\n -u \"gwSPoasWSdNkMDtBN3Hu2WYQpPWCO9SwUEsKK22l:fI6ZpfocHYBGfm1tP92r0yIgCyfRdDQt0Tos9L8a4fNsJjQQMwp9569e\nIaUBsaVDgt2eiwOGe0bg5m5vCSstClZmtdy359RVx2rQK5YlIWyPlrolpt2LEpVeKXWaiybo\" \\\n http://localhost:8013/api/o/token/ -i\n```\nIn the above post request, parameters `username` and `password` are username and password of the related\nAWX user of the underlying application, and the authentication information is of format\n`:`, where `client_id` and `client_secret` are the corresponding fields of\nunderlying application.\n\nUpon success, access token, refresh token and other information are given in the response body in JSON", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/role_definitions/": { + "get": { + "operationId": "api_v2_role_definitions_list", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleDefinition" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_v2_role_definitions_create", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleDefinition" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/RoleDefinition" } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/role_definitions/{id}/": { + "get": { + "operationId": "api_v2_role_definitions_read", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/RoleDefinition" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_v2_role_definitions_update", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleDefinitionDetail" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/RoleDefinitionDetail" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_v2_role_definitions_partial_update", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleDefinition" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/RoleDefinition" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_v2_role_definitions_delete", + "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "A unique integer value identifying this role definition.", + "required": true, + "type": "integer" + } + ] + }, + "/api/v2/role_definitions/{id}/team_assignments/": { + "get": { + "operationId": "api_v2_role_definitions_team_assignments_list", + "summary": "Manage Role Team Assignment objects in the 'team_assignments' relationship of this particular Role Definition.", + "description": "Starting from the detail URL:\n\nGET /:id/team_assignments/ to show role team assignments currently in the relationship", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleTeamAssignment" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/v2/role_definitions/{id}/user_assignments/": { + "get": { + "operationId": "api_v2_role_definitions_user_assignments_list", + "summary": "Manage Role User Assignment objects in the 'user_assignments' relationship of this particular Role Definition.", + "description": "Starting from the detail URL:\n\nGET /:id/user_assignments/ to show role user assignments currently in the relationship", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleUserAssignment" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/v2/role_metadata/": { + "get": { + "operationId": "api_v2_role_metadata_list", + "summary": "General data about models and permissions tracked by django-ansible-base RBAC", + "description": "Information from this endpoint should be static given a server version.\nThis reflects model definitions, registrations with the permission registry,\nand enablement of RBAC features in settings.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleMetadata" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/role_team_assignments/": { + "get": { + "operationId": "api_v2_role_team_assignments_list", + "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleTeamAssignment" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_v2_role_team_assignments_create", + "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleTeamAssignment" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/RoleTeamAssignment" } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/role_team_assignments/{id}/": { + "get": { + "operationId": "api_v2_role_team_assignments_read", + "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/RoleTeamAssignment" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_v2_role_team_assignments_delete", + "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/v2/role_user_assignments/": { + "get": { + "operationId": "api_v2_role_user_assignments_list", + "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/RoleUserAssignment" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_v2_role_user_assignments_create", + "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleUserAssignment" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/RoleUserAssignment" } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/role_user_assignments/{id}/": { + "get": { + "operationId": "api_v2_role_user_assignments_read", + "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/RoleUserAssignment" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_v2_role_user_assignments_delete", + "description": "Use this endpoint to give a user permission to a resource or an organization.\nThe needed data is the user, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/v2/service-index/": { + "get": { + "operationId": "api_v2_service-index_list", + "description": "Link other resource registry endpoints", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + } + ], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/service-index/metadata/": { + "get": { + "operationId": "api_v2_service-index_metadata_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + } + ], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/service-index/resource-types/": { + "get": { + "operationId": "api_v2_service-index_resource-types_list", + "description": "Index of the resource types that are configured in the system.", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceType" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/service-index/resource-types/{name}/": { + "get": { + "operationId": "api_v2_service-index_resource-types_read", + "description": "Index of the resource types that are configured in the system.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ResourceType" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "pattern": "[^/]+" + } + ] + }, + "/api/v2/service-index/resource-types/{name}/manifest/": { + "get": { + "operationId": "api_v2_service-index_resource-types_manifest", + "description": "Returns the as a stream the csv of resource_id,hash for a given resource type.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ResourceType" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "pattern": "[^/]+" + } + ] + }, + "/api/v2/service-index/resources/": { + "get": { + "operationId": "api_v2_service-index_resources_list", + "description": "Index of all the resources in the system.", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_v2_service-index_resources_create", + "description": "Index of all the resources in the system.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Resource" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Resource" } + } + }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/v2/service-index/resources/{ansible_id}/": { + "get": { + "operationId": "api_v2_service-index_resources_read", + "description": "Index of all the resources in the system.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Resource" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_v2_service-index_resources_update", + "description": "Index of all the resources in the system.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Resource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Resource" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_v2_service-index_resources_partial_update", + "description": "Index of all the resources in the system.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Resource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Resource" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_v2_service-index_resources_delete", + "description": "Index of all the resources in the system.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { + "name": "ansible_id", + "in": "path", + "required": true, + "type": "string", + "format": "uuid" + } + ] + }, + "/api/v2/service-index/validate-local-account/": { + "post": { + "operationId": "api_v2_service-index_validate-local-account_create", + "description": "Validate a user's username and password.", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [] + }, + "/api/{version}/": { + "get": { + "operationId": "api_read", + "description": "List top level resources", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/activity_stream/": { + "get": { + "operationId": "api_activity_stream_list", + "summary": "# List Activity Streams:", + "description": "Make a GET request to this resource to retrieve the list of\nactivity streams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/activity_stream/{id}/": { + "get": { + "operationId": "api_activity_stream_read", + "summary": "# Retrieve an Activity Stream:", + "description": "Make GET request to this resource to retrieve a single activity stream\nrecord containing the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ActivityStream" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_command_events/{id}/": { + "get": { + "operationId": "api_ad_hoc_command_events_read", + "summary": "# Retrieve an Ad Hoc Command Event:", + "description": "Make GET request to this resource to retrieve a single ad hoc command event\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandEvent" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/": { + "get": { + "operationId": "api_ad_hoc_commands_list", + "summary": "# List Ad Hoc Commands:", + "description": "Make a GET request to this resource to retrieve the list of\nad hoc commands.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_ad_hoc_commands_create", + "summary": "# List Ad Hoc Commands:", + "description": "Make a GET request to this resource to retrieve the list of\nad hoc commands.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/": { + "get": { + "operationId": "api_ad_hoc_commands_read", + "summary": "# Retrieve an Ad Hoc Command:", + "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n\n\n\n\n\n# Delete an Ad Hoc Command:\n\nMake a DELETE request to this resource to delete this ad hoc command.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_ad_hoc_commands_delete", + "summary": "# Retrieve an Ad Hoc Command:", + "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n\n\n\n\n\n# Delete an Ad Hoc Command:\n\nMake a DELETE request to this resource to delete this ad hoc command.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/activity_stream/": { + "get": { + "operationId": "api_ad_hoc_commands_activity_stream_list", + "summary": "# List Activity Streams for an Ad Hoc Command:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/cancel/": { + "get": { + "operationId": "api_ad_hoc_commands_cancel_read", + "summary": "# Retrieve an Ad Hoc Command:", + "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_ad_hoc_commands_cancel_create", + "summary": "# Retrieve an Ad Hoc Command:", + "description": "Make GET request to this resource to retrieve a single ad hoc command\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/events/": { + "get": { + "operationId": "api_ad_hoc_commands_events_list", + "summary": "# List Ad Hoc Command Events for an Ad Hoc Command:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc command events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command event records. \n\n## Results\n\nEach ad hoc command event data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that ad hoc command events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/notifications/": { + "get": { + "operationId": "api_ad_hoc_commands_notifications_list", + "summary": "# List Notifications for an Ad Hoc Command:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nad hoc command.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/relaunch/": { + "get": { + "operationId": "api_ad_hoc_commands_relaunch_list", + "summary": "Relaunch an Ad Hoc Command:", + "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandRelaunch" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_ad_hoc_commands_relaunch_create", + "summary": "Relaunch an Ad Hoc Command:", + "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandRelaunch" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandRelaunch" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ad_hoc_commands/{id}/stdout/": { + "get": { + "operationId": "api_ad_hoc_commands_stdout_read", + "summary": "# Retrieve Ad Hoc Command Stdout:", + "description": "Make GET request to this resource to retrieve the stdout from running this\nad hoc command.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/UnifiedJobStdout" } + } + }, + "produces": [ + "text/plain", + "text/plain", + "application/json", + "text/plain", + "text/plain" + ], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/": { + "get": { + "operationId": "api_analytics_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/adoption_rate/": { + "get": { + "operationId": "api_analytics_adoption_rate_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_adoption_rate_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/adoption_rate_options/": { + "get": { + "operationId": "api_analytics_adoption_rate_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_adoption_rate_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/authorized/": { + "get": { + "operationId": "api_analytics_authorized_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_authorized_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/event_explorer/": { + "get": { + "operationId": "api_analytics_event_explorer_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_event_explorer_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/event_explorer_options/": { + "get": { + "operationId": "api_analytics_event_explorer_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_event_explorer_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/host_explorer/": { + "get": { + "operationId": "api_analytics_host_explorer_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_host_explorer_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/host_explorer_options/": { + "get": { + "operationId": "api_analytics_host_explorer_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_host_explorer_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/job_explorer/": { + "get": { + "operationId": "api_analytics_job_explorer_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_job_explorer_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/job_explorer_options/": { + "get": { + "operationId": "api_analytics_job_explorer_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_job_explorer_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/probe_template_for_hosts/": { + "get": { + "operationId": "api_analytics_probe_template_for_hosts_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_probe_template_for_hosts_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/probe_template_for_hosts_options/": { + "get": { + "operationId": "api_analytics_probe_template_for_hosts_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_probe_template_for_hosts_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/probe_templates/": { + "get": { + "operationId": "api_analytics_probe_templates_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_probe_templates_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/probe_templates_options/": { + "get": { + "operationId": "api_analytics_probe_templates_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_probe_templates_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/report/{slug}/": { + "get": { + "operationId": "api_analytics_report_read", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_report_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "slug", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/report_options/": { + "get": { + "operationId": "api_analytics_report_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_report_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/reports/": { + "get": { + "operationId": "api_analytics_reports_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_reports_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/roi_templates/": { + "get": { + "operationId": "api_analytics_roi_templates_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_roi_templates_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/analytics/roi_templates_options/": { + "get": { + "operationId": "api_analytics_roi_templates_options_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_analytics_roi_templates_options_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/applications/": { + "get": { + "operationId": "api_applications_list", + "summary": "# List Applications:", + "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Application" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_applications_create", + "summary": "# List Applications:", + "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/applications/{id}/": { + "get": { + "operationId": "api_applications_read", + "summary": "# Retrieve an Application:", + "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_applications_update", + "summary": "# Retrieve an Application:", + "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_applications_partial_update", + "summary": "# Retrieve an Application:", + "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_applications_delete", + "summary": "# Retrieve an Application:", + "description": "Make GET request to this resource to retrieve a single application\nrecord containing the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n\n\n# Update an Application:\n\nMake a PUT or PATCH request to this resource to update this\napplication. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this application. (string, required)\n* `description`: Optional description of this application. (string, default=`\"\"`)\n\n\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice, required)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string, default=`\"\"`)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice, required)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean, default=`False`)\n* `organization`: Organization containing this application. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Application:\n\nMake a DELETE request to this resource to delete this application.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/applications/{id}/activity_stream/": { + "get": { + "operationId": "api_applications_activity_stream_list", + "summary": "# List Activity Streams for an Application:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/applications/{id}/tokens/": { + "get": { + "operationId": "api_applications_tokens_list", + "summary": "# List Access Tokens for an Application:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Token" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_applications_tokens_create", + "summary": "# List Access Tokens for an Application:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\napplication.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/auth/": { + "get": { + "operationId": "api_auth_list", + "description": "List enabled single-sign-on endpoints", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/bulk/": { + "get": { + "operationId": "api_bulk_list", + "description": "List top level resources", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/bulk/host_create/": { + "get": { + "operationId": "api_bulk_host_create_list", + "summary": "# Bulk Host Create", + "description": "This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/BulkHostCreate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_bulk_host_create_create", + "summary": "# Bulk Host Create", + "description": "This endpoint allows the client to create multiple hosts and associate them with an inventory. They may do this by providing the inventory ID and a list of json that would normally be provided to create hosts.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/BulkHostCreate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/BulkHostCreate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/bulk/host_delete/": { + "get": { + "operationId": "api_bulk_host_delete_list", + "summary": "# Bulk Host Delete", + "description": "This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/BulkHostDelete" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_bulk_host_delete_create", + "summary": "# Bulk Host Delete", + "description": "This endpoint allows the client to delete multiple hosts from inventories.\nThey may do this by providing a list of hosts ID's to be deleted.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/BulkHostDelete" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/BulkHostDelete" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/bulk/job_launch/": { + "get": { + "operationId": "api_bulk_job_launch_list", + "summary": "# Bulk Job Launch", + "description": "This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/BulkJobLaunch" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_bulk_job_launch_create", + "summary": "# Bulk Job Launch", + "description": "This endpoint allows the client to launch multiple UnifiedJobTemplates at a time, along side any launch time parameters that they would normally set at launch time.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/BulkJobLaunch" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/BulkJobLaunch" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/config/": { + "get": { + "operationId": "api_config_list", + "description": "Return various sitewide configuration settings", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "post": { + "operationId": "api_config_create", + "summary": "# Site configuration settings and general information", + "description": "Make a GET request to this resource to retrieve the configuration containing\nthe following fields (some fields may not be visible to all users):\n\n* `project_base_dir`: Path on the server where projects and playbooks are \\\n stored.\n* `project_local_paths`: List of directories beneath `project_base_dir` to\n use when creating/editing a manual project.\n* `time_zone`: The configured time zone for the server.\n* `license_info`: Information about the current license.\n* `version`: Version of Ansible Tower package installed.\n* `custom_virtualenvs`: Deprecated venv locations from before migration to\n execution environments. Export tooling is in `awx-manage` commands.\n* `eula`: The current End-User License Agreement\n\n\n\n# Install or update an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a POST request to this resource as a super\nuser to install or update the existing license. The license data itself can\nbe POSTed as a normal json data structure.\n\n(_New in Ansible Tower 2.1.1_) The POST must include a `eula_accepted` boolean\nelement indicating acceptance of the End-User License Agreement.\n\n\n\n# Delete an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a DELETE request to this resource as a super\nuser to delete the existing license", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_config_delete", + "summary": "# Site configuration settings and general information", + "description": "Make a GET request to this resource to retrieve the configuration containing\nthe following fields (some fields may not be visible to all users):\n\n* `project_base_dir`: Path on the server where projects and playbooks are \\\n stored.\n* `project_local_paths`: List of directories beneath `project_base_dir` to\n use when creating/editing a manual project.\n* `time_zone`: The configured time zone for the server.\n* `license_info`: Information about the current license.\n* `version`: Version of Ansible Tower package installed.\n* `custom_virtualenvs`: Deprecated venv locations from before migration to\n execution environments. Export tooling is in `awx-manage` commands.\n* `eula`: The current End-User License Agreement\n\n\n\n# Install or update an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a POST request to this resource as a super\nuser to install or update the existing license. The license data itself can\nbe POSTed as a normal json data structure.\n\n(_New in Ansible Tower 2.1.1_) The POST must include a `eula_accepted` boolean\nelement indicating acceptance of the End-User License Agreement.\n\n\n\n# Delete an existing license\n\n(_New in Ansible Tower 2.0.0_) Make a DELETE request to this resource as a super\nuser to delete the existing license", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/config/attach/": { + "post": { + "operationId": "api_config_attach_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/config/subscriptions/": { + "post": { + "operationId": "api_config_subscriptions_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/constructed_inventories/": { + "get": { + "operationId": "api_constructed_inventories_list", + "summary": "# List Inventories:", + "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ConstructedInventory" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_constructed_inventories_create", + "summary": "# List Inventories:", + "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/constructed_inventories/{id}/": { + "get": { + "operationId": "api_constructed_inventories_read", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_constructed_inventories_update", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_constructed_inventories_partial_update", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ConstructedInventory" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_constructed_inventories_delete", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n* `source_vars`: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `update_cache_timeout`: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n* `limit`: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default=`\"\"`)\n* `verbosity`: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=`None`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_input_sources/": { + "get": { + "operationId": "api_credential_input_sources_list", + "summary": "# List Credential Input Sources:", + "description": "Make a GET request to this resource to retrieve the list of\ncredential input sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/CredentialInputSource" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credential_input_sources_create", + "summary": "# List Credential Input Sources:", + "description": "Make a GET request to this resource to retrieve the list of\ncredential input sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_input_sources/{id}/": { + "get": { + "operationId": "api_credential_input_sources_read", + "summary": "# Retrieve a Credential Input Source:", + "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_credential_input_sources_update", + "summary": "# Retrieve a Credential Input Source:", + "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_credential_input_sources_partial_update", + "summary": "# Retrieve a Credential Input Source:", + "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_credential_input_sources_delete", + "summary": "# Retrieve a Credential Input Source:", + "description": "Make GET request to this resource to retrieve a single credential input source\nrecord containing the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n\n\n# Update a Credential Input Source:\n\nMake a PUT or PATCH request to this resource to update this\ncredential input source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this credential input source. (string, default=`\"\"`)\n* `input_field_name`: (string, required)\n* `metadata`: (json, default=`{}`)\n* `target_credential`: (id, required)\n* `source_credential`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Input Source:\n\nMake a DELETE request to this resource to delete this credential input source.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_types/": { + "get": { + "operationId": "api_credential_types_list", + "summary": "# List Credential Types:", + "description": "Make a GET request to this resource to retrieve the list of\ncredential types.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential types\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential type records. \n\n## Results\n\nEach credential type data structure includes the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n## Sorting\n\nTo specify that credential types are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/CredentialType" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credential_types_create", + "summary": "# List Credential Types:", + "description": "Make a GET request to this resource to retrieve the list of\ncredential types.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential types\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential type records. \n\n## Results\n\nEach credential type data structure includes the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n## Sorting\n\nTo specify that credential types are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialType" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialType" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_types/{id}/": { + "get": { + "operationId": "api_credential_types_read", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialType" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_credential_types_update", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialType" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialType" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_credential_types_partial_update", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialType" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialType" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_credential_types_delete", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:\n\n* `id`: Database ID for this credential type. (integer)\n* `type`: Data type for this credential type. (choice)\n* `url`: URL for this credential type. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential type was created. (datetime)\n* `modified`: Timestamp when this credential type was last modified. (datetime)\n* `name`: Name of this credential type. (string)\n* `description`: Optional description of this credential type. (string)\n* `kind`: (choice)\n - `ssh`: Machine\n - `vault`: Vault\n - `net`: Network\n - `scm`: Source Control\n - `cloud`: Cloud\n - `registry`: Container Registry\n - `token`: Personal Access Token\n - `insights`: Insights\n - `external`: External\n - `kubernetes`: Kubernetes\n - `galaxy`: Galaxy/Automation Hub\n - `cryptography`: Cryptography\n* `namespace`: (string)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n\n\n\n\n\n# Update a Credential Type:\n\nMake a PUT or PATCH request to this resource to update this\ncredential type. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential type. (string, required)\n* `description`: Optional description of this credential type. (string, default=`\"\"`)\n* `kind`: (choice, required)\n - `net`: Network\n - `cloud`: Cloud\n\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n* `injectors`: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential Type:\n\nMake a DELETE request to this resource to delete this credential type.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_types/{id}/activity_stream/": { + "get": { + "operationId": "api_credential_types_activity_stream_list", + "summary": "# List Activity Streams for a Credential Type:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_types/{id}/credentials/": { + "get": { + "operationId": "api_credential_types_credentials_list", + "summary": "# List Credentials for a Credential Type:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credential_types_credentials_create", + "summary": "# List Credentials for a Credential Type:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ncredential type.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credential_types/{id}/test/": { + "get": { + "operationId": "api_credential_types_test_read", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credential_types_test_create", + "summary": "# Retrieve a Credential Type:", + "description": "Make GET request to this resource to retrieve a single credential type\nrecord containing the following fields:", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/": { + "get": { + "operationId": "api_credentials_list", + "summary": "# List Credentials:", + "description": "Make a GET request to this resource to retrieve the list of\ncredentials.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/CredentialSerializerCreate" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credentials_create", + "summary": "# List Credentials:", + "description": "Make a GET request to this resource to retrieve the list of\ncredentials.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialSerializerCreate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialSerializerCreate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/": { + "get": { + "operationId": "api_credentials_read", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_credentials_update", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_credentials_partial_update", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_credentials_delete", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n\n# Update a Credential:\n\nMake a PUT or PATCH request to this resource to update this\ncredential. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this credential. (string, required)\n* `description`: Optional description of this credential. (string, default=`\"\"`)\n* `organization`: (id, default=`None`)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)\n\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default=`{}`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Credential:\n\nMake a DELETE request to this resource to delete this credential.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/access_list/": { + "get": { + "operationId": "api_credentials_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/activity_stream/": { + "get": { + "operationId": "api_credentials_activity_stream_list", + "summary": "# List Activity Streams for a Credential:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/copy/": { + "get": { + "operationId": "api_credentials_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credentials_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/input_sources/": { + "get": { + "operationId": "api_credentials_input_sources_list", + "summary": "# List Credential Input Sources for a Credential:", + "description": "Make a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/CredentialInputSource" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credentials_input_sources_create", + "summary": "# List Credential Input Sources for a Credential:", + "description": "Make a GET request to this resource to retrieve a list of\ncredential input sources associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credential input sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential input source records. \n\n## Results\n\nEach credential input source data structure includes the following fields:\n\n* `id`: Database ID for this credential input source. (integer)\n* `type`: Data type for this credential input source. (choice)\n* `url`: URL for this credential input source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential input source was created. (datetime)\n* `modified`: Timestamp when this credential input source was last modified. (datetime)\n* `description`: Optional description of this credential input source. (string)\n* `input_field_name`: (string)\n* `metadata`: (json)\n* `target_credential`: (id)\n* `source_credential`: (id)\n\n\n\n## Sorting\n\nTo specify that credential input sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/CredentialInputSource" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/object_roles/": { + "get": { + "operationId": "api_credentials_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Credential:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/owner_teams/": { + "get": { + "operationId": "api_credentials_owner_teams_list", + "summary": "# List Teams for a Credential:", + "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/owner_users/": { + "get": { + "operationId": "api_credentials_owner_users_list", + "summary": "# List Users for a Credential:", + "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\ncredential.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/credentials/{id}/test/": { + "get": { + "operationId": "api_credentials_test_read", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_credentials_test_create", + "summary": "# Retrieve a Credential:", + "description": "Make GET request to this resource to retrieve a single credential\nrecord containing the following fields:", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/dashboard/": { + "get": { + "operationId": "api_dashboard_list", + "description": "Show Dashboard Details", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/dashboard/graphs/jobs/": { + "get": { + "operationId": "api_dashboard_graphs_jobs_list", + "summary": "# View Statistics for Job Runs", + "description": "Make a GET request to this resource to retrieve aggregate statistics about job runs suitable for graphing.\n\n## Parameters and Filtering\n\nThe `period` of the data can be adjusted with:\n\n ?period=month\n\nWhere `month` can be replaced with `week`, `two_weeks`, or `day`. `month` is the default.\n\nThe type of job can be filtered with:\n\n ?job_type=all\n\nWhere `all` can be replaced with `inv_sync`, `playbook_run` or `scm_update`. `all` is the default.\n\n## Results\n\nData will be returned in the following format:\n\n \"jobs\": {\n \"successful\": [\n [\n 1402808400.0, \n 9\n ], ... ],\n \"failed\": [\n \t [\n 1402808400.0, \n 3\n ], ... ]\n }\n\nEach element contains an epoch timestamp represented in seconds and a numerical value indicating\nthe number of events during that time period", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/execution_environments/": { + "get": { + "operationId": "api_execution_environments_list", + "summary": "# List Execution Environments:", + "description": "Make a GET request to this resource to retrieve the list of\nexecution environments.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ExecutionEnvironment" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_execution_environments_create", + "summary": "# List Execution Environments:", + "description": "Make a GET request to this resource to retrieve the list of\nexecution environments.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/execution_environments/{id}/": { + "get": { + "operationId": "api_execution_environments_read", + "summary": "# Retrieve an Execution Environment:", + "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_execution_environments_update", + "summary": "# Retrieve an Execution Environment:", + "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_execution_environments_partial_update", + "summary": "# Retrieve an Execution Environment:", + "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_execution_environments_delete", + "summary": "# Retrieve an Execution Environment:", + "description": "Make GET request to this resource to retrieve a single execution environment\nrecord containing the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n# Update an Execution Environment:\n\nMake a PUT or PATCH request to this resource to update this\nexecution environment. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this execution environment. (string, required)\n* `description`: Optional description of this execution environment. (string, default=`\"\"`)\n* `organization`: The organization used to determine access to this execution environment. (id, default=``)\n* `image`: The full image location, including the container registry, image name, and version tag. (string, required)\n\n* `credential`: (id, default=``)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: --------- (default)\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Execution Environment:\n\nMake a DELETE request to this resource to delete this execution environment.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/execution_environments/{id}/activity_stream/": { + "get": { + "operationId": "api_execution_environments_activity_stream_list", + "summary": "# List Activity Streams for an Execution Environment:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nexecution environment.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/execution_environments/{id}/copy/": { + "get": { + "operationId": "api_execution_environments_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_execution_environments_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/execution_environments/{id}/unified_job_templates/": { + "get": { + "operationId": "api_execution_environments_unified_job_templates_list", + "summary": "# List Unified Job Templates for an Execution Environment:", + "description": "Make a GET request to this resource to retrieve a list of\nunified job templates associated with the selected\nexecution environment.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job template records. \n\n## Results\n\nEach unified job template data structure includes the following fields:\n\n* `id`: Database ID for this unified job template. (integer)\n* `type`: Data type for this unified job template. (choice)\n* `url`: URL for this unified job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job template was created. (datetime)\n* `modified`: Timestamp when this unified job template was last modified. (datetime)\n* `name`: Name of this unified job template. (string)\n* `description`: Optional description of this unified job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n\n\n\n## Sorting\n\nTo specify that unified job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/": { + "get": { + "operationId": "api_groups_list", + "summary": "# List Groups:", + "description": "Make a GET request to this resource to retrieve the list of\ngroups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_groups_create", + "summary": "# List Groups:", + "description": "Make a GET request to this resource to retrieve the list of\ngroups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/": { + "get": { + "operationId": "api_groups_read", + "summary": "# Retrieve a Group:", + "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_groups_update", + "summary": "# Retrieve a Group:", + "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_groups_partial_update", + "summary": "# Retrieve a Group:", + "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_groups_delete", + "summary": "# Retrieve a Group:", + "description": "Make GET request to this resource to retrieve a single group\nrecord containing the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n\n\n# Update a Group:\n\nMake a PUT or PATCH request to this resource to update this\ngroup. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this group. (string, required)\n* `description`: Optional description of this group. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `variables`: Group variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Group:\n\nMake a DELETE request to this resource to delete this group.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/activity_stream/": { + "get": { + "operationId": "api_groups_activity_stream_list", + "summary": "# List Activity Streams for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/ad_hoc_commands/": { + "get": { + "operationId": "api_groups_ad_hoc_commands_list", + "summary": "# List Ad Hoc Commands for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_groups_ad_hoc_commands_create", + "summary": "# List Ad Hoc Commands for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/all_hosts/": { + "get": { + "operationId": "api_groups_all_hosts_list", + "summary": "# List All Hosts for a Group:", + "description": "Make a GET request to this resource to retrieve a list of all\nhosts directly or indirectly belonging to this\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Host" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/children/": { + "get": { + "operationId": "api_groups_children_list", + "summary": "# List Groups for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_groups_children_create", + "summary": "# List Groups for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/hosts/": { + "get": { + "operationId": "api_groups_hosts_list", + "summary": "# List Hosts for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Host" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_groups_hosts_create", + "summary": "# List Hosts for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Host" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/inventory_sources/": { + "get": { + "operationId": "api_groups_inventory_sources_list", + "summary": "# List Inventory Sources for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventorySource" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/job_events/": { + "get": { + "operationId": "api_groups_job_events_list", + "summary": "# List Job Events for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/job_host_summaries/": { + "get": { + "operationId": "api_groups_job_host_summaries_list", + "summary": "# List Job Host Summaries for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\ngroup.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobHostSummary" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/potential_children/": { + "get": { + "operationId": "api_groups_potential_children_list", + "summary": "# List Potential Child Groups for a Group:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups available to be added as children of the\ncurrent group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/groups/{id}/variable_data/": { + "get": { + "operationId": "api_groups_variable_data_read", + "summary": "# Retrieve Group Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/GroupVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "put": { + "operationId": "api_groups_variable_data_update", + "summary": "# Retrieve Group Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/GroupVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/GroupVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "patch": { + "operationId": "api_groups_variable_data_partial_update", + "summary": "# Retrieve Group Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ngroup.\n\n\n\n# Update Group Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ngroup.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/GroupVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/GroupVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/host_metric_summary_monthly/": { + "get": { + "operationId": "api_host_metric_summary_monthly_list", + "summary": "# List Host Metric Summary Monthlys:", + "description": "Make a GET request to this resource to retrieve the list of\nhost metric summary monthlys.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of host metric summary monthlys\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host metric summary monthly records. \n\n## Results\n\nEach host metric summary monthly data structure includes the following fields:\n\n* `id`: Database ID for this host metric summary monthly. (integer)\n* `date`: (date)\n* `license_consumed`: How many unique hosts are consumed from the license (integer)\n* `license_capacity`: 'License capacity as max. number of unique hosts (integer)\n* `hosts_added`: How many hosts were added in the associated month, consuming more license capacity (integer)\n* `hosts_deleted`: How many hosts were deleted in the associated month, freeing the license capacity (integer)\n* `indirectly_managed_hosts`: Manually entered number indirectly managed hosts for a certain month (integer)\n\n\n\n## Sorting\n\nTo specify that host metric summary monthlys are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/HostMetricSummaryMonthly" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/host_metrics/": { + "get": { + "operationId": "api_host_metrics_list", + "summary": "# List Host Metrics:", + "description": "Make a GET request to this resource to retrieve the list of\nhost metrics.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of host metrics\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host metric records. \n\n## Results\n\nEach host metric data structure includes the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n## Sorting\n\nTo specify that host metrics are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/HostMetric" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/host_metrics/{id}/": { + "get": { + "operationId": "api_host_metrics_read", + "summary": "# Retrieve a Host Metric:", + "description": "Make GET request to this resource to retrieve a single host metric\nrecord containing the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n\n\n# Delete a Host Metric:\n\nMake a DELETE request to this resource to soft-delete this host metric.\n\nA soft deletion will mark the `deleted` field as true and exclude the host\nmetric from license calculations.\nThis may be undone later if the same hostname is automated again afterwards.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/HostMetric" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_host_metrics_delete", + "summary": "# Retrieve a Host Metric:", + "description": "Make GET request to this resource to retrieve a single host metric\nrecord containing the following fields:\n\n* `id`: Database ID for this host metric. (integer)\n* `hostname`: (string)\n* `url`: URL for this host metric. (string)\n* `first_automation`: When the host was first automated against (datetime)\n* `last_automation`: When the host was last automated against (datetime)\n* `last_deleted`: When the host was last deleted (datetime)\n* `automated_counter`: How many times was the host automated (integer)\n* `deleted_counter`: How many times was the host deleted (integer)\n* `deleted`: Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption (boolean)\n* `used_in_inventories`: How many inventories contain this host (integer)\n\n\n\n\n\n# Delete a Host Metric:\n\nMake a DELETE request to this resource to soft-delete this host metric.\n\nA soft deletion will mark the `deleted` field as true and exclude the host\nmetric from license calculations.\nThis may be undone later if the same hostname is automated again afterwards.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/": { + "get": { + "operationId": "api_hosts_list", + "summary": "# List Hosts:", + "description": "Make a GET request to this resource to retrieve the list of\nhosts.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Host" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_hosts_create", + "summary": "# List Hosts:", + "description": "Make a GET request to this resource to retrieve the list of\nhosts.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Host" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/": { + "get": { + "operationId": "api_hosts_read", + "summary": "# Retrieve a Host:", + "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_hosts_update", + "summary": "# Retrieve a Host:", + "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Host" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_hosts_partial_update", + "summary": "# Retrieve a Host:", + "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Host" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_hosts_delete", + "summary": "# Retrieve a Host:", + "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n\n\n# Update a Host:\n\nMake a PUT or PATCH request to this resource to update this\nhost. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this host. (string, required)\n* `description`: Optional description of this host. (string, default=`\"\"`)\n* `inventory`: (id, required)\n* `enabled`: Is this host online and available for running jobs? (boolean, default=`True`)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string, default=`\"\"`)\n* `variables`: Host variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Host:\n\nMake a DELETE request to this resource to delete this host.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/activity_stream/": { + "get": { + "operationId": "api_hosts_activity_stream_list", + "summary": "# List Activity Streams for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/ad_hoc_command_events/": { + "get": { + "operationId": "api_hosts_ad_hoc_command_events_list", + "summary": "# List Ad Hoc Command Events for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc command events associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc command events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command event records. \n\n## Results\n\nEach ad hoc command event data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command event. (integer)\n* `type`: Data type for this ad hoc command event. (choice)\n* `url`: URL for this ad hoc command event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command event was created. (datetime)\n* `modified`: Timestamp when this ad hoc command event was last modified. (datetime)\n* `ad_hoc_command`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_ok`: Host OK\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_skipped`: Host Skipped\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that ad hoc command events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/ad_hoc_commands/": { + "get": { + "operationId": "api_hosts_ad_hoc_commands_list", + "summary": "# List Ad Hoc Commands for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_hosts_ad_hoc_commands_create", + "summary": "# List Ad Hoc Commands for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/all_groups/": { + "get": { + "operationId": "api_hosts_all_groups_list", + "summary": "# List All Groups for a Host:", + "description": "Make a GET request to this resource to retrieve a list of all\ngroups of which the selected\nhost is directly or indirectly a member.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/ansible_facts/": { + "get": { + "operationId": "api_hosts_ansible_facts_read", + "summary": "# Retrieve a Host:", + "description": "Make GET request to this resource to retrieve a single host\nrecord containing the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/AnsibleFacts" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/groups/": { + "get": { + "operationId": "api_hosts_groups_list", + "summary": "# List Groups for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_hosts_groups_create", + "summary": "# List Groups for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/inventory_sources/": { + "get": { + "operationId": "api_hosts_inventory_sources_list", + "summary": "# List Inventory Sources for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventorySource" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/job_events/": { + "get": { + "operationId": "api_hosts_job_events_list", + "summary": "# List Job Events for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/job_host_summaries/": { + "get": { + "operationId": "api_hosts_job_host_summaries_list", + "summary": "# List Job Host Summaries for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobHostSummary" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/smart_inventories/": { + "get": { + "operationId": "api_hosts_smart_inventories_list", + "summary": "# List Inventories for a Host:", + "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\nhost.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Inventory" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/hosts/{id}/variable_data/": { + "get": { + "operationId": "api_hosts_variable_data_read", + "summary": "# Retrieve Host Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/HostVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "put": { + "operationId": "api_hosts_variable_data_update", + "summary": "# Retrieve Host Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/HostVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/HostVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "patch": { + "operationId": "api_hosts_variable_data_partial_update", + "summary": "# Retrieve Host Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\nhost.\n\n\n\n# Update Host Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\nhost.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/HostVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/HostVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/": { + "get": { + "operationId": "api_instance_groups_list", + "summary": "# List Instance Groups:", + "description": "Make a GET request to this resource to retrieve the list of\ninstance groups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_instance_groups_create", + "summary": "# List Instance Groups:", + "description": "Make a GET request to this resource to retrieve the list of\ninstance groups.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/{id}/": { + "get": { + "operationId": "api_instance_groups_read", + "summary": "# Retrieve an Instance Group:", + "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_instance_groups_update", + "summary": "# Retrieve an Instance Group:", + "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_instance_groups_partial_update", + "summary": "# Retrieve an Instance Group:", + "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_instance_groups_delete", + "summary": "# Retrieve an Instance Group:", + "description": "Make GET request to this resource to retrieve a single instance group\nrecord containing the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n\n\n# Update an Instance Group:\n\nMake a PUT or PATCH request to this resource to update this\ninstance group. The following fields may be modified:\n\n\n\n\n\n\n* `name`: Name of this instance group. (string, required)\n\n\n\n\n\n\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=`0`)\n\n\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``)\n* `credential`: (id, default=``)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=`0`)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json, default=``)\n* `pod_spec_override`: (string, default=`\"\"`)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Instance Group:\n\nMake a DELETE request to this resource to delete this instance group.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/{id}/access_list/": { + "get": { + "operationId": "api_instance_groups_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/{id}/instances/": { + "get": { + "operationId": "api_instance_groups_instances_list", + "summary": "# List Instances for an Instance Group:", + "description": "Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Instance" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_instance_groups_instances_create", + "summary": "# List Instances for an Instance Group:", + "description": "Make a GET request to this resource to retrieve a list of\ninstances associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Instance" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Instance" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/{id}/jobs/": { + "get": { + "operationId": "api_instance_groups_jobs_list", + "summary": "# List Unified Jobs for an Instance Group:", + "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instance_groups/{id}/object_roles/": { + "get": { + "operationId": "api_instance_groups_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for an Instance Group:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ninstance group.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/": { + "get": { + "operationId": "api_instances_list", + "summary": "# List Instances:", + "description": "Make a GET request to this resource to retrieve the list of\ninstances.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Instance" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_instances_create", + "summary": "# List Instances:", + "description": "Make a GET request to this resource to retrieve the list of\ninstances.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instances\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance records. \n\n## Results\n\nEach instance data structure includes the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n## Sorting\n\nTo specify that instances are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Instance" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Instance" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/": { + "get": { + "operationId": "api_instances_read", + "summary": "# Retrieve an Instance:", + "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Instance" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_instances_update", + "summary": "# Retrieve an Instance:", + "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Instance" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Instance" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_instances_partial_update", + "summary": "# Retrieve an Instance:", + "description": "Make GET request to this resource to retrieve a single instance\nrecord containing the following fields:\n\n* `id`: Database ID for this instance. (integer)\n* `hostname`: (string)\n* `type`: Data type for this instance. (choice)\n* `url`: URL for this instance. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `uuid`: (string)\n* `created`: Timestamp when this instance was created. (datetime)\n* `modified`: Timestamp when this instance was last modified. (datetime)\n* `last_seen`: Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. (datetime)\n* `health_check_started`: The last time a health check was initiated on this instance. (datetime)\n* `health_check_pending`: (field)\n* `last_health_check`: Last time a health check was ran on this instance to refresh cpu, memory, and capacity. (datetime)\n* `errors`: Any error details from the last health check. (string)\n* `capacity_adjustment`: (decimal)\n* `version`: (string)\n* `capacity`: (integer)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: Count of jobs in the running or waiting state that are targeted for this instance (integer)\n* `jobs_total`: Count of all jobs that target this instance (integer)\n* `cpu`: (decimal)\n* `memory`: Total system memory of this instance in bytes. (integer)\n* `cpu_capacity`: (integer)\n* `mem_capacity`: (integer)\n* `enabled`: (boolean)\n* `managed_by_policy`: (boolean)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n* `managed`: If True, this instance is managed by the control plane. (boolean)\n* `ip_address`: (string)\n* `peers`: Primary keys of receptor addresses to peer to. (field)\n* `reverse_peers`: (field)\n* `listener_port`: (integer)\n* `peers_from_control_nodes`: (boolean)\n* `protocol`: (field)\n\n\n\n\n\n# Update an Instance:\n\nMake a PUT or PATCH request to this resource to update this\ninstance. The following fields may be modified:\n\n\n\n* `hostname`: (string, required)\n\n\n\n\n\n\n\n\n\n\n\n\n* `capacity_adjustment`: (decimal, default=`1`)\n\n\n\n\n\n\n\n\n\n\n* `enabled`: (boolean, default=`True`)\n* `managed_by_policy`: (boolean, default=`True`)\n* `node_type`: Role that this node plays in the mesh. (choice)\n - `control`: Control plane node\n - `execution`: Execution plane node (default)\n - `hybrid`: Controller and execution\n - `hop`: Message-passing node, no execution capability\n* `node_state`: Indicates the current life cycle stage of this instance. (choice)\n - `provisioning`: Provisioning\n - `provision-fail`: Provisioning Failure\n - `installed`: Installed (default)\n - `ready`: Ready\n - `unavailable`: Unavailable\n - `deprovisioning`: De-provisioning\n - `deprovision-fail`: De-provisioning Failure\n\n\n* `peers`: Primary keys of receptor addresses to peer to. (field, default=`None`)\n\n* `listener_port`: (integer, default=``)\n* `peers_from_control_nodes`: (boolean, default=``)\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Instance" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Instance" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/health_check/": { + "get": { + "operationId": "api_instances_health_check_list", + "summary": "# Health Check Data", + "description": "Health checks are used to obtain important data about an instance.\nInstance fields affected by the health check are shown in this view.\nFundamentally, health checks require running code on the machine in question.\n\n - For instances with `node_type` of \"control\" or \"hybrid\", health checks are\nperformed as part of a periodic task that runs in the background.\n - For instances with `node_type` of \"execution\", health checks are done by submitting\na work unit through the receptor mesh.\n\nIf ran through the receptor mesh, the invoked command is:\n\n```\nansible-runner worker --worker-info\n```\n\nFor execution nodes, these checks are _not_ performed on a regular basis.\nHealth checks against functional nodes will be ran when the node is first discovered.\nHealth checks against nodes with errors will be repeated at a reduced frequency.\n\n\n\n\n# Manually Initiate a Health Check\nFor purposes of error remediation or debugging, a health check can be\nmanually initiated by making a POST request to this endpoint.\n\nThis will submit the work unit to the target node through the receptor mesh and wait for it to finish.\nThe model will be updated with the result.\nUp-to-date values of the fields will be returned in the response data.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceHealthCheck" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_instances_health_check_create", + "summary": "# Health Check Data", + "description": "Health checks are used to obtain important data about an instance.\nInstance fields affected by the health check are shown in this view.\nFundamentally, health checks require running code on the machine in question.\n\n - For instances with `node_type` of \"control\" or \"hybrid\", health checks are\nperformed as part of a periodic task that runs in the background.\n - For instances with `node_type` of \"execution\", health checks are done by submitting\na work unit through the receptor mesh.\n\nIf ran through the receptor mesh, the invoked command is:\n\n```\nansible-runner worker --worker-info\n```\n\nFor execution nodes, these checks are _not_ performed on a regular basis.\nHealth checks against functional nodes will be ran when the node is first discovered.\nHealth checks against nodes with errors will be repeated at a reduced frequency.\n\n\n\n\n# Manually Initiate a Health Check\nFor purposes of error remediation or debugging, a health check can be\nmanually initiated by making a POST request to this endpoint.\n\nThis will submit the work unit to the target node through the receptor mesh and wait for it to finish.\nThe model will be updated with the result.\nUp-to-date values of the fields will be returned in the response data.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceHealthCheck" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceHealthCheck" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/install_bundle/": { + "get": { + "operationId": "api_instances_install_bundle_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Instance" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/instance_groups/": { + "get": { + "operationId": "api_instances_instance_groups_list", + "summary": "# List Instance Groups for an Instance:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_instances_instance_groups_create", + "summary": "# List Instance Groups for an Instance:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/jobs/": { + "get": { + "operationId": "api_instances_jobs_list", + "summary": "# List Unified Jobs for an Instance:", + "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/peers/": { + "get": { + "operationId": "api_instances_peers_list", + "summary": "# List Receptor Addresss for an Instance:", + "description": "Make a GET request to this resource to retrieve a list of\nreceptor addresss associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ReceptorAddress" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/instances/{id}/receptor_addresses/": { + "get": { + "operationId": "api_instances_receptor_addresses_list", + "summary": "# List Receptor Addresss for an Instance:", + "description": "Make a GET request to this resource to retrieve a list of\nreceptor addresss associated with the selected\ninstance.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ReceptorAddress" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/": { + "get": { + "operationId": "api_inventories_list", + "summary": "# List Inventories:", + "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Inventory" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_create", + "summary": "# List Inventories:", + "description": "Make a GET request to this resource to retrieve the list of\ninventories.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Inventory" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Inventory" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/": { + "get": { + "operationId": "api_inventories_read", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Inventory" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_inventories_update", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Inventory" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Inventory" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_inventories_partial_update", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Inventory" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Inventory" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_inventories_delete", + "summary": "# Retrieve an Inventory:", + "description": "Make GET request to this resource to retrieve a single inventory\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update an Inventory:\n\nMake a PUT or PATCH request to this resource to update this\ninventory. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory. (string, required)\n* `description`: Optional description of this inventory. (string, default=`\"\"`)\n* `organization`: Organization containing this inventory. (id, required)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory. (default)\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string, default=`\"\"`)\n* `variables`: Inventory variables in JSON or YAML format. (json, default=``)\n\n\n\n\n\n\n\n\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory:\n\nMake a DELETE request to this resource to delete this inventory.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/access_list/": { + "get": { + "operationId": "api_inventories_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/activity_stream/": { + "get": { + "operationId": "api_inventories_activity_stream_list", + "summary": "# List Activity Streams for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/ad_hoc_commands/": { + "get": { + "operationId": "api_inventories_ad_hoc_commands_list", + "summary": "# List Ad Hoc Commands for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/AdHocCommandList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_ad_hoc_commands_create", + "summary": "# List Ad Hoc Commands for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nad hoc commands associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of ad hoc commands\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more ad hoc command records. \n\n## Results\n\nEach ad hoc command data structure includes the following fields:\n\n* `id`: Database ID for this ad hoc command. (integer)\n* `type`: Data type for this ad hoc command. (choice)\n* `url`: URL for this ad hoc command. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this ad hoc command was created. (datetime)\n* `modified`: Timestamp when this ad hoc command was last modified. (datetime)\n* `name`: Name of this ad hoc command. (string)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `limit`: (string)\n* `credential`: (id)\n* `module_name`: (choice)\n - `command`\n - `shell`\n - `yum`\n - `apt`\n - `apt_key`\n - `apt_repository`\n - `apt_rpm`\n - `service`\n - `group`\n - `user`\n - `mount`\n - `ping`\n - `selinux`\n - `setup`\n - `win_ping`\n - `win_service`\n - `win_updates`\n - `win_group`\n - `win_user`\n* `module_args`: (string)\n* `forks`: (integer)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (string)\n* `become_enabled`: (boolean)\n* `diff_mode`: (boolean)\n\n\n\n## Sorting\n\nTo specify that ad hoc commands are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/AdHocCommandList" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/copy/": { + "get": { + "operationId": "api_inventories_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/groups/": { + "get": { + "operationId": "api_inventories_groups_list", + "summary": "# List Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_groups_create", + "summary": "# List Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/hosts/": { + "get": { + "operationId": "api_inventories_hosts_list", + "summary": "# List Hosts for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Host" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_hosts_create", + "summary": "# List Hosts for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Host" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Host" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/input_inventories/": { + "get": { + "operationId": "api_inventories_input_inventories_list", + "summary": "# List Inventories for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Inventory" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_input_inventories_create", + "summary": "# List Inventories for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Inventory" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Inventory" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/instance_groups/": { + "get": { + "operationId": "api_inventories_instance_groups_list", + "summary": "# List Instance Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_instance_groups_create", + "summary": "# List Instance Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/inventory_sources/": { + "get": { + "operationId": "api_inventories_inventory_sources_list", + "summary": "# List Inventory Sources for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventorySource" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_inventory_sources_create", + "summary": "# List Inventory Sources for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySource" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySource" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/job_templates/": { + "get": { + "operationId": "api_inventories_job_templates_list", + "summary": "# List Job Templates for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/labels/": { + "get": { + "operationId": "api_inventories_labels_list", + "summary": "# List Labels for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_labels_create", + "summary": "# List Labels for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/object_roles/": { + "get": { + "operationId": "api_inventories_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for an Inventory:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/root_groups/": { + "get": { + "operationId": "api_inventories_root_groups_list", + "summary": "# List Root Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_root_groups_create", + "summary": "# List Root Groups for an Inventory:", + "description": "Make a GET request to this resource to retrieve a list of root (top-level)\ngroups associated with this\ninventory.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Group" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Group" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/script/": { + "get": { + "operationId": "api_inventories_script_read", + "summary": "Generate inventory group and host data as needed for an inventory script.", + "description": "Refer to [Dynamic Inventory](http://docs.ansible.com/intro_dynamic_inventory.html)\nfor more information on inventory scripts.\n\n## List Response\n\nMake a GET request to this resource without query parameters to retrieve a JSON\nobject containing groups, including the hosts, children and variables for each\ngroup. The response data is equivalent to that returned by passing the\n`--list` argument to an inventory script.\n\nSpecify a query string of `?hostvars=1` to retrieve the JSON\nobject above including all host variables. The `['_meta']['hostvars']` object\nin the response contains an entry for each host with its variables. This\nresponse format can be used with Ansible 1.3 and later to avoid making a\nseparate API request for each host. Refer to\n[Tuning the External Inventory Script](http://docs.ansible.com/developing_inventory.html#tuning-the-external-inventory-script)\nfor more information on this feature.\n\nBy default, the inventory script will only return hosts that\nare enabled in the inventory. This feature allows disabled hosts to be skipped\nwhen running jobs without removing them from the inventory. Specify a query\nstring of `?all=1` to return all hosts, including disabled ones.\n\nSpecify a query string of `?towervars=1` to add variables\nto the hostvars of each host that specifies its enabled state and database ID.\n\nSpecify a query string of `?subset=slice2of5` to produce an inventory that\nhas a restricted number of hosts according to the rules of job slicing.\n\nTo apply multiple query strings, join them with the `&` character, like `?hostvars=1&all=1`.\n\n## Host Response\n\nMake a GET request to this resource with a query string similar to\n`?host=HOSTNAME` to retrieve a JSON object containing host variables for the\nspecified host. The response data is equivalent to that returned by passing\nthe `--host HOSTNAME` argument to an inventory script.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryScript" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/tree/": { + "get": { + "operationId": "api_inventories_tree_read", + "summary": "# Group Tree for an Inventory:", + "description": "Make a GET request to this resource to retrieve a hierarchical view of groups\nassociated with the selected inventory.\n\nThe resulting data structure contains a list of root groups, with each group\nalso containing a list of its children.\n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n* `children`: (field)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/GroupTree" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/update_inventory_sources/": { + "get": { + "operationId": "api_inventories_update_inventory_sources_read", + "summary": "# Update Inventory Sources", + "description": "Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:\n\n* `inventory_source`: ID of the inventory_source\n (integer, read-only)\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:\n\n* `status`: `started` or message why the update could not be started.\n (string, read-only)\n* `inventory_update`: ID of the inventory update job that was started.\n (integer, read-only)\n* `project_update`: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventories_update_inventory_sources_create", + "summary": "# Update Inventory Sources", + "description": "Make a GET request to this resource to determine if any of the inventory sources for\nthis inventory can be updated. The response will include the following fields for each\ninventory source:\n\n* `inventory_source`: ID of the inventory_source\n (integer, read-only)\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory sources. The response\nstatus code will be a 202. The response will contain the follow fields for each of the individual\ninventory sources:\n\n* `status`: `started` or message why the update could not be started.\n (string, read-only)\n* `inventory_update`: ID of the inventory update job that was started.\n (integer, read-only)\n* `project_update`: ID of the project update job that was started if this inventory source is an SCM source.\n (integer, read-only, optional)", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventories/{id}/variable_data/": { + "get": { + "operationId": "api_inventories_variable_data_read", + "summary": "# Retrieve Inventory Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "put": { + "operationId": "api_inventories_variable_data_update", + "summary": "# Retrieve Inventory Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventoryVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "patch": { + "operationId": "api_inventories_variable_data_partial_update", + "summary": "# Retrieve Inventory Variable Data:", + "description": "Make a GET request to this resource to retrieve all variables defined for a\ninventory.\n\n\n\n# Update Inventory Variable Data:\n\nMake a PUT or PATCH request to this resource to update variables defined for a\ninventory.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventoryVariableData" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryVariableData" } + } + }, + "consumes": ["application/json", "application/yaml"], + "produces": ["application/json", "application/yaml"], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/": { + "get": { + "operationId": "api_inventory_sources_list", + "summary": "# List Inventory Sources:", + "description": "Make a GET request to this resource to retrieve the list of\ninventory sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventorySource" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_create", + "summary": "# List Inventory Sources:", + "description": "Make a GET request to this resource to retrieve the list of\ninventory sources.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySource" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySource" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/": { + "get": { + "operationId": "api_inventory_sources_read", + "summary": "# Retrieve an Inventory Source:", + "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySource" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_inventory_sources_update", + "summary": "# Retrieve an Inventory Source:", + "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySource" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_inventory_sources_partial_update", + "summary": "# Retrieve an Inventory Source:", + "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySource" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySource" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_inventory_sources_delete", + "summary": "# Retrieve an Inventory Source:", + "description": "Make GET request to this resource to retrieve a single inventory source\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update an Inventory Source:\n\nMake a PUT or PATCH request to this resource to update this\ninventory source. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this inventory source. (string, required)\n* `description`: Optional description of this inventory source. (string, default=`\"\"`)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string, default=`\"\"`)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string, default=`\"\"`)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `credential`: Cloud credential to use for inventory updates. (integer, default=`None`)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string, default=`\"\"`)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string, default=`\"\"`)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string, default=`\"\"`)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean, default=`False`)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean, default=`False`)\n\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO) (default)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `inventory`: (id, required)\n* `update_on_launch`: (boolean, default=`False`)\n* `update_cache_timeout`: (integer, default=`0`)\n* `source_project`: Project containing inventory file used as source. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Inventory Source:\n\nMake a DELETE request to this resource to delete this inventory source.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/activity_stream/": { + "get": { + "operationId": "api_inventory_sources_activity_stream_list", + "summary": "# List Activity Streams for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/credentials/": { + "get": { + "operationId": "api_inventory_sources_credentials_list", + "summary": "# List Credentials for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_credentials_create", + "summary": "# List Credentials for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/groups/": { + "get": { + "operationId": "api_inventory_sources_groups_list", + "summary": "# List Groups for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Group" } + } + } + } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_inventory_sources_groups_delete", + "summary": "# List Groups for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\ngroups associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more group records. \n\n## Results\n\nEach group data structure includes the following fields:\n\n* `id`: Database ID for this group. (integer)\n* `type`: Data type for this group. (choice)\n* `url`: URL for this group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this group was created. (datetime)\n* `modified`: Timestamp when this group was last modified. (datetime)\n* `name`: Name of this group. (string)\n* `description`: Optional description of this group. (string)\n* `inventory`: (id)\n* `variables`: Group variables in JSON or YAML format. (json)\n\n\n\n## Sorting\n\nTo specify that groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/hosts/": { + "get": { + "operationId": "api_inventory_sources_hosts_list", + "summary": "# List Hosts for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Host" } + } + } + } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_inventory_sources_hosts_delete", + "summary": "# List Hosts for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nhosts associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of hosts\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more host records. \n\n## Results\n\nEach host data structure includes the following fields:\n\n* `id`: Database ID for this host. (integer)\n* `type`: Data type for this host. (choice)\n* `url`: URL for this host. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this host was created. (datetime)\n* `modified`: Timestamp when this host was last modified. (datetime)\n* `name`: Name of this host. (string)\n* `description`: Optional description of this host. (string)\n* `inventory`: (id)\n* `enabled`: Is this host online and available for running jobs? (boolean)\n* `instance_id`: The value used by the remote inventory source to uniquely identify the host (string)\n* `variables`: Host variables in JSON or YAML format. (json)\n* `has_active_failures`: (field)\n* `has_inventory_sources`: (field)\n* `last_job`: (id)\n* `last_job_host_summary`: (id)\n* `ansible_facts_modified`: The date and time ansible_facts was last modified. (datetime)\n\n\n\n## Sorting\n\nTo specify that hosts are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/inventory_updates/": { + "get": { + "operationId": "api_inventory_sources_inventory_updates_list", + "summary": "# List Inventory Updates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventoryUpdateList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/notification_templates_error/": { + "get": { + "operationId": "api_inventory_sources_notification_templates_error_list", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_notification_templates_error_create", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/notification_templates_started/": { + "get": { + "operationId": "api_inventory_sources_notification_templates_started_list", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_notification_templates_started_create", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/notification_templates_success/": { + "get": { + "operationId": "api_inventory_sources_notification_templates_success_list", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_notification_templates_success_create", + "summary": "# List Notification Templates for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/schedules/": { + "get": { + "operationId": "api_inventory_sources_schedules_list", + "summary": "# List Schedules for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_schedules_create", + "summary": "# List Schedules for an Inventory Source:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\ninventory source.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_sources/{id}/update/": { + "get": { + "operationId": "api_inventory_sources_update_read", + "summary": "# Update Inventory Source", + "description": "Make a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:\n\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_sources_update_create", + "summary": "# Update Inventory Source", + "description": "Make a GET request to this resource to determine if the group can be updated\nfrom its inventory source. The response will include the following field:\n\n* `can_update`: Flag indicating if this inventory source can be updated\n (boolean, read-only)\n\nMake a POST request to this resource to update the inventory source. If\nsuccessful, the response status code will be 202. If the inventory source is\nnot defined or cannot be updated, a 405 status code will be returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InventorySourceUpdate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/": { + "get": { + "operationId": "api_inventory_updates_list", + "summary": "# List Inventory Updates:", + "description": "Make a GET request to this resource to retrieve the list of\ninventory updates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventoryUpdateList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/": { + "get": { + "operationId": "api_inventory_updates_read", + "summary": "# Retrieve an Inventory Update:", + "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n* `source_project`: The project used for this job. (field)\n\n\n\n\n\n# Delete an Inventory Update:\n\nMake a DELETE request to this resource to delete this inventory update.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryUpdateDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_inventory_updates_delete", + "summary": "# Retrieve an Inventory Update:", + "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n* `source_project`: The project used for this job. (field)\n\n\n\n\n\n# Delete an Inventory Update:\n\nMake a DELETE request to this resource to delete this inventory update.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/cancel/": { + "get": { + "operationId": "api_inventory_updates_cancel_read", + "summary": "# Retrieve an Inventory Update:", + "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryUpdateCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_inventory_updates_cancel_create", + "summary": "# Retrieve an Inventory Update:", + "description": "Make GET request to this resource to retrieve a single inventory update\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InventoryUpdateCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InventoryUpdateCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/credentials/": { + "get": { + "operationId": "api_inventory_updates_credentials_list", + "summary": "# List Credentials for an Inventory Update:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/events/": { + "get": { + "operationId": "api_inventory_updates_events_list", + "summary": "# List Inventory Update Events for an Inventory Update:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory update events associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory update events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update event records. \n\n## Results\n\nEach inventory update event data structure includes the following fields:\n\n* `id`: Database ID for this inventory update event. (integer)\n* `type`: Data type for this inventory update event. (choice)\n* `url`: URL for this inventory update event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update event was created. (datetime)\n* `modified`: Timestamp when this inventory update event was last modified. (datetime)\n* `event`: (field)\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (field)\n* `changed`: (field)\n* `uuid`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `inventory_update`: (id)\n\n\n\n## Sorting\n\nTo specify that inventory update events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventoryUpdateEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/notifications/": { + "get": { + "operationId": "api_inventory_updates_notifications_list", + "summary": "# List Notifications for an Inventory Update:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\ninventory update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/inventory_updates/{id}/stdout/": { + "get": { + "operationId": "api_inventory_updates_stdout_read", + "summary": "# Retrieve Inventory Update Stdout:", + "description": "Make GET request to this resource to retrieve the stdout from running this\ninventory update.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/UnifiedJobStdout" } + } + }, + "produces": [ + "text/plain", + "text/plain", + "application/json", + "text/plain", + "text/plain" + ], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_events/{id}/": { + "get": { + "operationId": "api_job_events_read", + "summary": "# Retrieve a Job Event:", + "description": "Make GET request to this resource to retrieve a single job event\nrecord containing the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobEvent" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_events/{id}/children/": { + "get": { + "operationId": "api_job_events_children_list", + "summary": "# List Job Events for a Job Event:", + "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob event.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_host_summaries/{id}/": { + "get": { + "operationId": "api_job_host_summaries_read", + "summary": "# Retrieve a Job Host Summary:", + "description": "Make GET request to this resource to retrieve a single job host summary\nrecord containing the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobHostSummary" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/": { + "get": { + "operationId": "api_job_templates_list", + "summary": "# List Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\njob templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_create", + "summary": "# List Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\njob templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/": { + "get": { + "operationId": "api_job_templates_read", + "summary": "# Retrieve a Job Template:", + "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobTemplate" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_job_templates_update", + "summary": "# Retrieve a Job Template:", + "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobTemplate" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_job_templates_partial_update", + "summary": "# Retrieve a Job Template:", + "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobTemplate" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_job_templates_delete", + "summary": "# Retrieve a Job Template:", + "description": "Make GET request to this resource to retrieve a single job template\nrecord containing the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n\n\n# Update a Job Template:\n\nMake a PUT or PATCH request to this resource to update this\njob template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this job template. (string, required)\n* `description`: Optional description of this job template. (string, default=`\"\"`)\n* `job_type`: (choice)\n - `run`: Run (default)\n - `check`: Check\n* `inventory`: (id, default=``)\n* `project`: (id, default=``)\n* `playbook`: (string, default=`\"\"`)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=`\"\"`)\n* `forks`: (integer, default=`0`)\n* `limit`: (string, default=`\"\"`)\n* `verbosity`: (choice)\n - `0`: 0 (Normal) (default)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json, default=``)\n* `job_tags`: (string, default=`\"\"`)\n* `force_handlers`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `start_at_task`: (string, default=`\"\"`)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=`False`)\n\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `host_config_key`: (string, default=`\"\"`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_diff_mode_on_launch`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_job_type_on_launch`: (boolean, default=`False`)\n* `ask_verbosity_on_launch`: (boolean, default=`False`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_credential_on_launch`: (boolean, default=`False`)\n* `ask_execution_environment_on_launch`: (boolean, default=`False`)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_forks_on_launch`: (boolean, default=`False`)\n* `ask_job_slice_count_on_launch`: (boolean, default=`False`)\n* `ask_timeout_on_launch`: (boolean, default=`False`)\n* `ask_instance_groups_on_launch`: (boolean, default=`False`)\n* `survey_enabled`: (boolean, default=`False`)\n* `become_enabled`: (boolean, default=`False`)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=`1`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=`False`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Job Template:\n\nMake a DELETE request to this resource to delete this job template.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/access_list/": { + "get": { + "operationId": "api_job_templates_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/activity_stream/": { + "get": { + "operationId": "api_job_templates_activity_stream_list", + "summary": "# List Activity Streams for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/bitbucket_dc/": { + "post": { + "operationId": "api_job_templates_bitbucket_dc_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/callback/": { + "get": { + "operationId": "api_job_templates_callback_list", + "summary": "The job template callback allows for ephemeral hosts to launch a new job.", + "description": "Configure a host to POST to this resource, passing the `host_config_key`\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the `N` parameter with the `id` of the job template\nand the `HOST_CONFIG_KEY` with the `host_config_key` associated with the\njob template.\n\nFor example, using curl:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\n\nOr using wget:\n\n wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n\nYou may also pass `extra_vars` to the callback:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\n\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.\n\n_(New in Ansible Tower 2.0.0)_ If the associated inventory has the\n`update_on_launch` flag set and if the `update_cache_timeout` has expired, the\ncallback will perform an inventory sync to find a matching host.\n\nA GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:\n\n curl http://user:password@server/api/v2/job_templates/N/callback/\n\nThe response will include the host config key as well as the host name(s)\nthat would match the request:\n\n {\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n }", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_callback_create", + "summary": "The job template callback allows for ephemeral hosts to launch a new job.", + "description": "Configure a host to POST to this resource, passing the `host_config_key`\nparameter, to start a new job limited to only the requesting host. In the\nexamples below, replace the `N` parameter with the `id` of the job template\nand the `HOST_CONFIG_KEY` with the `host_config_key` associated with the\njob template.\n\nFor example, using curl:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\"}' http://server/api/v2/job_templates/N/callback/\n\nOr using wget:\n\n wget -O /dev/null --post-data='{\"host_config_key\": \"HOST_CONFIG_KEY\"}' --header=Content-Type:application/json http://server/api/v2/job_templates/N/callback/\n\nYou may also pass `extra_vars` to the callback:\n\n curl -H \"Content-Type: application/json\" -d '{\"host_config_key\": \"HOST_CONFIG_KEY\", \"extra_vars\": {\"key\": \"value\"}}' http://server/api/v2/job_templates/N/callback/\n\nThe response will return status 202 if the request is valid, 403 for an\ninvalid host config key, or 400 if the host cannot be determined from the\naddress making the request.\n\n_(New in Ansible Tower 2.0.0)_ If the associated inventory has the\n`update_on_launch` flag set and if the `update_cache_timeout` has expired, the\ncallback will perform an inventory sync to find a matching host.\n\nA GET request may be used to verify that the correct host will be selected.\nThis request must authenticate as a valid user with permission to edit the\njob template. For example:\n\n curl http://user:password@server/api/v2/job_templates/N/callback/\n\nThe response will include the host config key as well as the host name(s)\nthat would match the request:\n\n {\n \"host_config_key\": \"HOST_CONFIG_KEY\",\n \"matching_hosts\": [\"hostname\"]\n }", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/copy/": { + "get": { + "operationId": "api_job_templates_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/credentials/": { + "get": { + "operationId": "api_job_templates_credentials_list", + "summary": "# List Credentials for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_credentials_create", + "summary": "# List Credentials for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/github/": { + "post": { + "operationId": "api_job_templates_github_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/gitlab/": { + "post": { + "operationId": "api_job_templates_gitlab_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/instance_groups/": { + "get": { + "operationId": "api_job_templates_instance_groups_list", + "summary": "# List Instance Groups for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_instance_groups_create", + "summary": "# List Instance Groups for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/jobs/": { + "get": { + "operationId": "api_job_templates_jobs_list", + "summary": "# List Jobs for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\njobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job records. \n\n## Results\n\nEach job data structure includes the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n\n\n\n## Sorting\n\nTo specify that jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/labels/": { + "get": { + "operationId": "api_job_templates_labels_list", + "summary": "# List Labels for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_labels_create", + "summary": "# List Labels for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/launch/": { + "get": { + "operationId": "api_job_templates_launch_read", + "summary": "Launch a Job Template:", + "description": "Make a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:\n\n* `ask_variables_on_launch`: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)\n* `ask_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)\n* `ask_skip_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)\n* `ask_job_type_on_launch`: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)\n* `ask_limit_on_launch`: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)\n* `ask_inventory_on_launch`: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)\n* `ask_credential_on_launch`: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)\n* `can_start_without_user_input`: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)\n* `passwords_needed_to_start`: Password names required to launch the\n job_template (array, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)\n* `inventory_needed_to_start`: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)\n\nMake a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the `inventory_needed_to_start` is `True` then the\n`inventory` is required.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobLaunch" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_launch_create", + "summary": "Launch a Job Template:", + "description": "Make a GET request to this resource to determine if the job_template can be\nlaunched and whether any passwords are required to launch the job_template.\nThe response will include the following fields:\n\n* `ask_variables_on_launch`: Flag indicating whether the job_template is\n configured to prompt for variables upon launch (boolean, read-only)\n* `ask_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for tags upon launch (boolean, read-only)\n* `ask_skip_tags_on_launch`: Flag indicating whether the job_template is\n configured to prompt for skip_tags upon launch (boolean, read-only)\n* `ask_job_type_on_launch`: Flag indicating whether the job_template is\n configured to prompt for job_type upon launch (boolean, read-only)\n* `ask_limit_on_launch`: Flag indicating whether the job_template is\n configured to prompt for limit upon launch (boolean, read-only)\n* `ask_inventory_on_launch`: Flag indicating whether the job_template is\n configured to prompt for inventory upon launch (boolean, read-only)\n* `ask_credential_on_launch`: Flag indicating whether the job_template is\n configured to prompt for credential upon launch (boolean, read-only)\n* `can_start_without_user_input`: Flag indicating if the job_template can be\n launched without user-input (boolean, read-only)\n* `passwords_needed_to_start`: Password names required to launch the\n job_template (array, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the job_template has an enabled\n survey (boolean, read-only)\n* `inventory_needed_to_start`: Flag indicating the presence of an inventory\n associated with the job template. If not then one should be supplied when\n launching the job (boolean, read-only)\n\nMake a POST request to this resource to launch the job_template. If any\npasswords, inventory, or extra variables (extra_vars) are required, they must\nbe passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses. If the `inventory_needed_to_start` is `True` then the\n`inventory` is required.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the job cannot be\nlaunched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobLaunch" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobLaunch" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/notification_templates_error/": { + "get": { + "operationId": "api_job_templates_notification_templates_error_list", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_notification_templates_error_create", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/notification_templates_started/": { + "get": { + "operationId": "api_job_templates_notification_templates_started_list", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_notification_templates_started_create", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/notification_templates_success/": { + "get": { + "operationId": "api_job_templates_notification_templates_success_list", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_notification_templates_success_create", + "summary": "# List Notification Templates for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/object_roles/": { + "get": { + "operationId": "api_job_templates_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Job Template:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/schedules/": { + "get": { + "operationId": "api_job_templates_schedules_list", + "summary": "# List Schedules for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_schedules_create", + "summary": "# List Schedules for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/slice_workflow_jobs/": { + "get": { + "operationId": "api_job_templates_slice_workflow_jobs_list", + "summary": "# List Workflow Jobs for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_slice_workflow_jobs_create", + "summary": "# List Workflow Jobs for a Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\njob template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobList" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobList" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/survey_spec/": { + "get": { + "operationId": "api_job_templates_survey_spec_list", + "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_survey_spec_create", + "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_job_templates_survey_spec_delete", + "summary": "POST requests to this resource should include the full specification for a Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/job_templates/{id}/webhook_key/": { + "get": { + "operationId": "api_job_templates_webhook_key_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_job_templates_webhook_key_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/": { + "get": { + "operationId": "api_jobs_list", + "summary": "# List Jobs:", + "description": "Make a GET request to this resource to retrieve the list of\njobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job records. \n\n## Results\n\nEach job data structure includes the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n\n\n\n## Sorting\n\nTo specify that jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/": { + "get": { + "operationId": "api_jobs_read", + "summary": "# Retrieve a Job:", + "description": "Make GET request to this resource to retrieve a single job\nrecord containing the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n* `custom_virtualenv`: (string)\n\n\n\n\n\n# Delete a Job:\n\nMake a DELETE request to this resource to delete this job.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_jobs_delete", + "summary": "# Retrieve a Job:", + "description": "Make GET request to this resource to retrieve a single job\nrecord containing the following fields:\n\n* `id`: Database ID for this job. (integer)\n* `type`: Data type for this job. (choice)\n* `url`: URL for this job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job was created. (datetime)\n* `modified`: Timestamp when this job was last modified. (datetime)\n* `name`: Name of this job. (string)\n* `description`: Optional description of this job. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n - `scan`: Scan\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this unified job. (id)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `job_template`: (id)\n* `passwords_needed_to_start`: (field)\n* `allow_simultaneous`: (boolean)\n* `artifacts`: (json)\n* `scm_revision`: The SCM Revision from the Project used for this job, if available (string)\n* `instance_group`: The Instance group the job was run under (id)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `job_slice_number`: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)\n* `job_slice_count`: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n* `custom_virtualenv`: (string)\n\n\n\n\n\n# Delete a Job:\n\nMake a DELETE request to this resource to delete this job.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/activity_stream/": { + "get": { + "operationId": "api_jobs_activity_stream_list", + "summary": "# List Activity Streams for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/cancel/": { + "get": { + "operationId": "api_jobs_cancel_read", + "summary": "# Determine if a Job can be canceled", + "description": "Make a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:\n\n* `can_cancel`: Indicates whether this job can be canceled (boolean, read-only)\n\n\n\n# Cancel a Job\nMake a POST request to this resource to cancel a pending or running job. The\nresponse status code will be 202 if successful, or 405 if the job cannot be\ncanceled.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_jobs_cancel_create", + "summary": "# Determine if a Job can be canceled", + "description": "Make a GET request to this resource to determine if the job can be canceled.\nThe response will include the following field:\n\n* `can_cancel`: Indicates whether this job can be canceled (boolean, read-only)\n\n\n\n# Cancel a Job\nMake a POST request to this resource to cancel a pending or running job. The\nresponse status code will be 202 if successful, or 405 if the job cannot be\ncanceled.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/create_schedule/": { + "get": { + "operationId": "api_jobs_create_schedule_read", + "summary": "Create a schedule based on a job:", + "description": "Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as `extra_vars`, `inventory`, `limit`, etc.\n\nJobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.\n\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobCreateSchedule" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_jobs_create_schedule_create", + "summary": "Create a schedule based on a job:", + "description": "Make a POST request to this endpoint to create a schedule that launches\nthe job template that launched this job, and uses the same\nparameters that the job was launched with. These parameters include all\n\"prompted\" resources such as `extra_vars`, `inventory`, `limit`, etc.\n\nJobs that were launched with user-provided passwords cannot have a schedule\ncreated from them.\n\nMake a GET request for information about what those prompts are and\nwhether or not a schedule can be created.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobCreateSchedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobCreateSchedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/credentials/": { + "get": { + "operationId": "api_jobs_credentials_list", + "summary": "# List Credentials for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/job_events/": { + "get": { + "operationId": "api_jobs_job_events_list", + "summary": "# List Job Events for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\njob events associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job event records. \n\n## Results\n\nEach job event data structure includes the following fields:\n\n* `id`: Database ID for this job event. (integer)\n* `type`: Data type for this job event. (choice)\n* `url`: URL for this job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job event was created. (datetime)\n* `modified`: Timestamp when this job event was last modified. (datetime)\n* `job`: (id)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `parent_uuid`: (string)\n* `host`: (id)\n* `host_name`: (string)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n\n\n\n## Sorting\n\nTo specify that job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/job_events/children_summary/": { + "get": { + "operationId": "api_jobs_job_events_children_summary_list", + "summary": "# View a summary of children events", + "description": "Special view to facilitate processing job output in the UI.\nIn order to collapse events and their children, the UI needs to know how\nmany children exist for a given event.\nThe UI also needs to know the order of the event (0 based index), which\nusually matches the counter, but not always.\nThis view returns a JSON object where the key is the event counter, and the value\nincludes the number of children (and grandchildren) events.\nOnly events with children are included in the output.\n\n## Example\n\ne.g. Demo Job Template job\ntuple(event counter, uuid, parent_uuid)\n\n```\n(1, '4598d19e-93b4-4e33-a0ae-b387a7348964', '')\n(2, 'aae0d189-e3cb-102a-9f00-000000000006', '4598d19e-93b4-4e33-a0ae-b387a7348964')\n(3, 'aae0d189-e3cb-102a-9f00-00000000000c', 'aae0d189-e3cb-102a-9f00-000000000006')\n(4, 'f4194f14-e406-4124-8519-0fdb08b18f4b', 'aae0d189-e3cb-102a-9f00-00000000000c')\n(5, '39f7ad99-dbf3-41e0-93f8-9999db4004f2', 'aae0d189-e3cb-102a-9f00-00000000000c')\n(6, 'aae0d189-e3cb-102a-9f00-000000000008', 'aae0d189-e3cb-102a-9f00-000000000006')\n(7, '39a49992-5ca4-4b6c-b178-e56d0b0333da', 'aae0d189-e3cb-102a-9f00-000000000008')\n(8, '504f3b28-3ea8-4f6f-bd82-60cf8e807cc0', 'aae0d189-e3cb-102a-9f00-000000000008')\n(9, 'a242be54-ebe6-4021-afab-f2878bff2e9f', '4598d19e-93b4-4e33-a0ae-b387a7348964')\n```\n\noutput\n\n```\n{\n\"1\": {\n \"rowNumber\": 0,\n \"numChildren\": 8\n},\n\"2\": {\n \"rowNumber\": 1,\n \"numChildren\": 6\n},\n\"3\": {\n \"rowNumber\": 2,\n \"numChildren\": 2\n},\n\"6\": {\n \"rowNumber\": 5,\n \"numChildren\": 2\n}\n}\n\"meta_event_nested_parent_uuid\": {}\n}\n```\n\ncounter 1 is event 0, and has 8 children\ncounter 2 is event 1, and has 6 children\netc.\n\nThe UI also needs to be able to collapse over \"meta\" events -- events that\nshow up due to verbosity or warnings from the system while the play is running.\nThese events have a 0 level event, with no parent uuid.\n\n```\nplaybook_on_start\nverbose\n playbook_on_play_start\n playbook_on_task_start\n runner_on_start <- level 3\nverbose <- jump to level 0\nverbose\n runner_on_ok <- jump back to level 3\n playbook_on_task_start\n runner_on_start\n runner_on_ok\nverbose\nverbose\n playbook_on_stats\n```\n\nThese verbose statements that fall in the middle of a series of children events\nare problematic for the UI.\nTo help, this view will attempt to place the events into the hierarchy, without\nthe event level jumps.\n\n```\nplaybook_on_start\n verbose\n playbook_on_play_start\n playbook_on_task_start\n runner_on_start <- A\n verbose <- this maps to the uuid of A\n verbose\n runner_on_ok\n playbook_on_task_start <- B\n runner_on_start\n runner_on_ok\n verbose <- this maps to the uuid of B\n verbose\n playbook_on_stats\n```\n\nThe output will include a JSON object where the key is the event counter,\nand the value is the assigned nested uuid.", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/job_host_summaries/": { + "get": { + "operationId": "api_jobs_job_host_summaries_list", + "summary": "# List Job Host Summaries for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\njob host summaries associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job host summaries\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job host summary records. \n\n## Results\n\nEach job host summary data structure includes the following fields:\n\n* `id`: Database ID for this job host summary. (integer)\n* `type`: Data type for this job host summary. (choice)\n* `url`: URL for this job host summary. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job host summary was created. (datetime)\n* `modified`: Timestamp when this job host summary was last modified. (datetime)\n* `job`: (id)\n* `host`: (id)\n* `constructed_host`: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)\n* `host_name`: (string)\n* `changed`: (integer)\n* `dark`: (integer)\n* `failures`: (integer)\n* `ok`: (integer)\n* `processed`: (integer)\n* `skipped`: (integer)\n* `failed`: (boolean)\n* `ignored`: (integer)\n* `rescued`: (integer)\n\n\n\n## Sorting\n\nTo specify that job host summaries are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobHostSummary" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/labels/": { + "get": { + "operationId": "api_jobs_labels_list", + "summary": "# List Labels for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/notifications/": { + "get": { + "operationId": "api_jobs_notifications_list", + "summary": "# List Notifications for a Job:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\njob.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/relaunch/": { + "get": { + "operationId": "api_jobs_relaunch_read", + "summary": "Relaunch a Job:", + "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/JobRelaunch" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_jobs_relaunch_create", + "summary": "Relaunch a Job:", + "description": "Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobRelaunch" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobRelaunch" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/jobs/{id}/stdout/": { + "get": { + "operationId": "api_jobs_stdout_read", + "summary": "# Retrieve Job Stdout:", + "description": "Make GET request to this resource to retrieve the stdout from running this\njob.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/UnifiedJobStdout" } + } + }, + "produces": [ + "text/plain", + "text/plain", + "application/json", + "text/plain", + "text/plain" + ], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/labels/": { + "get": { + "operationId": "api_labels_list", + "summary": "# List Labels:", + "description": "Make a GET request to this resource to retrieve the list of\nlabels.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_labels_create", + "summary": "# List Labels:", + "description": "Make a GET request to this resource to retrieve the list of\nlabels.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/labels/{id}/": { + "get": { + "operationId": "api_labels_read", + "summary": "# Retrieve a Label:", + "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_labels_update", + "summary": "# Retrieve a Label:", + "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_labels_partial_update", + "summary": "# Retrieve a Label:", + "description": "Make GET request to this resource to retrieve a single label\nrecord containing the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n\n\n# Update a Label:\n\nMake a PUT or PATCH request to this resource to update this\nlabel. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this label. (string, required)\n* `organization`: Organization this label belongs to. (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/me/": { + "get": { + "operationId": "api_me_list", + "summary": "# Retrieve Information about the current User", + "description": "Make a GET request to retrieve user information about the current user.\n\nOne result should be returned containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\nUse the primary URL for the user (/api/v2/users/N/) to modify the user.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/mesh_visualizer/": { + "get": { + "operationId": "api_mesh_visualizer_list", + "description": "Make a GET request to this resource to obtain a list all Receptor Nodes and their links.", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/metrics/": { + "get": { + "operationId": "api_metrics_list", + "description": "Show Metrics Details", + "parameters": [], + "responses": { "200": { "description": "" } }, + "produces": ["text/plain", "application/json"], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notification_templates/": { + "get": { + "operationId": "api_notification_templates_list", + "summary": "# List Notification Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nnotification templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_notification_templates_create", + "summary": "# List Notification Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nnotification templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notification_templates/{id}/": { + "get": { + "operationId": "api_notification_templates_read", + "summary": "# Retrieve a Notification Template:", + "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_notification_templates_update", + "summary": "# Retrieve a Notification Template:", + "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_notification_templates_partial_update", + "summary": "# Retrieve a Notification Template:", + "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_notification_templates_delete", + "summary": "# Retrieve a Notification Template:", + "description": "Make GET request to this resource to retrieve a single notification template\nrecord containing the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n\n\n# Update a Notification Template:\n\nMake a PUT or PATCH request to this resource to update this\nnotification template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this notification template. (string, required)\n* `description`: Optional description of this notification template. (string, default=`\"\"`)\n* `organization`: (id, required)\n* `notification_type`: (choice, required)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json, default=`{}`)\n* `messages`: Optional custom messages for notification template. (json, default=`{'started': None, 'success': None, 'error': None, 'workflow_approval': None}`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Notification Template:\n\nMake a DELETE request to this resource to delete this notification template.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notification_templates/{id}/copy/": { + "get": { + "operationId": "api_notification_templates_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_notification_templates_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notification_templates/{id}/notifications/": { + "get": { + "operationId": "api_notification_templates_notifications_list", + "summary": "# List Notifications for a Notification Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nnotification template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notification_templates/{id}/test/": { + "post": { + "operationId": "api_notification_templates_test_create", + "description": "Test a Notification Template", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notifications/": { + "get": { + "operationId": "api_notifications_list", + "summary": "# List Notifications:", + "description": "Make a GET request to this resource to retrieve the list of\nnotifications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/notifications/{id}/": { + "get": { + "operationId": "api_notifications_read", + "summary": "# Retrieve a Notification:", + "description": "Make GET request to this resource to retrieve a single notification\nrecord containing the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Notification" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/": { + "get": { + "operationId": "api_organizations_list", + "summary": "# List Organizations:", + "description": "Make a GET request to this resource to retrieve the list of\norganizations.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Organization" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_create", + "summary": "# List Organizations:", + "description": "Make a GET request to this resource to retrieve the list of\norganizations.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Organization" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Organization" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/": { + "get": { + "operationId": "api_organizations_read", + "summary": "# Retrieve an Organization:", + "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Organization" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_organizations_update", + "summary": "# Retrieve an Organization:", + "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Organization" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Organization" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_organizations_partial_update", + "summary": "# Retrieve an Organization:", + "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Organization" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Organization" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_organizations_delete", + "summary": "# Retrieve an Organization:", + "description": "Make GET request to this resource to retrieve a single organization\nrecord containing the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n\n\n# Update an Organization:\n\nMake a PUT or PATCH request to this resource to update this\norganization. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this organization. (string, required)\n* `description`: Optional description of this organization. (string, default=`\"\"`)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer, default=`0`)\n\n* `default_environment`: The default execution environment for jobs run by this organization. (id, default=``)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Organization:\n\nMake a DELETE request to this resource to delete this organization.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/access_list/": { + "get": { + "operationId": "api_organizations_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/activity_stream/": { + "get": { + "operationId": "api_organizations_activity_stream_list", + "summary": "# List Activity Streams for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/admins/": { + "get": { + "operationId": "api_organizations_admins_list", + "summary": "# List Admin Users for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of admin users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more admin user records. \n\n## Results\n\nEach admin user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that admin users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_admins_create", + "summary": "# List Admin Users for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nadmin users associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of admin users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more admin user records. \n\n## Results\n\nEach admin user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that admin users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/applications/": { + "get": { + "operationId": "api_organizations_applications_list", + "summary": "# List Applications for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Application" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_applications_create", + "summary": "# List Applications for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\napplications associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/credentials/": { + "get": { + "operationId": "api_organizations_credentials_list", + "summary": "# List Credentials for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationCredentialSerializerCreate" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_credentials_create", + "summary": "# List Credentials for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationCredentialSerializerCreate" + } + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/OrganizationCredentialSerializerCreate" + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/execution_environments/": { + "get": { + "operationId": "api_organizations_execution_environments_list", + "summary": "# List Execution Environments for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nexecution environments associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ExecutionEnvironment" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_execution_environments_create", + "summary": "# List Execution Environments for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nexecution environments associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of execution environments\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more execution environment records. \n\n## Results\n\nEach execution environment data structure includes the following fields:\n\n* `id`: Database ID for this execution environment. (integer)\n* `type`: Data type for this execution environment. (choice)\n* `url`: URL for this execution environment. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this execution environment was created. (datetime)\n* `modified`: Timestamp when this execution environment was last modified. (datetime)\n* `name`: Name of this execution environment. (string)\n* `description`: Optional description of this execution environment. (string)\n* `organization`: The organization used to determine access to this execution environment. (id)\n* `image`: The full image location, including the container registry, image name, and version tag. (string)\n* `managed`: (boolean)\n* `credential`: (id)\n* `pull`: Pull image before running? (choice)\n - `\"\"`: ---------\n - `always`: Always pull container before running.\n - `missing`: Only pull the image if not present before running.\n - `never`: Never pull container before running.\n\n\n\n## Sorting\n\nTo specify that execution environments are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/ExecutionEnvironment" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/galaxy_credentials/": { + "get": { + "operationId": "api_organizations_galaxy_credentials_list", + "summary": "# List Credentials for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_galaxy_credentials_create", + "summary": "# List Credentials for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/instance_groups/": { + "get": { + "operationId": "api_organizations_instance_groups_list", + "summary": "# List Instance Groups for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_instance_groups_create", + "summary": "# List Instance Groups for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/inventories/": { + "get": { + "operationId": "api_organizations_inventories_list", + "summary": "# List Inventories for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\ninventories associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventories\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory records. \n\n## Results\n\nEach inventory data structure includes the following fields:\n\n* `id`: Database ID for this inventory. (integer)\n* `type`: Data type for this inventory. (choice)\n* `url`: URL for this inventory. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory was created. (datetime)\n* `modified`: Timestamp when this inventory was last modified. (datetime)\n* `name`: Name of this inventory. (string)\n* `description`: Optional description of this inventory. (string)\n* `organization`: Organization containing this inventory. (id)\n* `kind`: Kind of inventory being represented. (choice)\n - `\"\"`: Hosts have a direct link to this inventory.\n - `smart`: Hosts for inventory generated using the host_filter property.\n - `constructed`: Parse list of source inventories with the constructed inventory plugin.\n* `host_filter`: Filter that will be applied to the hosts of this inventory. (string)\n* `variables`: Inventory variables in JSON or YAML format. (json)\n* `has_active_failures`: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)\n* `total_hosts`: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)\n* `hosts_with_active_failures`: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)\n* `total_groups`: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)\n* `has_inventory_sources`: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)\n* `total_inventory_sources`: Total number of external inventory sources configured within this inventory. (integer)\n* `inventory_sources_with_failures`: Number of external inventory sources in this inventory with failures. (integer)\n* `pending_deletion`: Flag indicating the inventory is being deleted. (boolean)\n* `prevent_instance_group_fallback`: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that inventories are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Inventory" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/job_templates/": { + "get": { + "operationId": "api_organizations_job_templates_list", + "summary": "# List Job Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/JobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_job_templates_create", + "summary": "# List Job Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\njob templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more job template records. \n\n## Results\n\nEach job template data structure includes the following fields:\n\n* `id`: Database ID for this job template. (integer)\n* `type`: Data type for this job template. (choice)\n* `url`: URL for this job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this job template was created. (datetime)\n* `modified`: Timestamp when this job template was last modified. (datetime)\n* `name`: Name of this job template. (string)\n* `description`: Optional description of this job template. (string)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `inventory`: (id)\n* `project`: (id)\n* `playbook`: (string)\n* `scm_branch`: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `forks`: (integer)\n* `limit`: (string)\n* `verbosity`: (choice)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `extra_vars`: (json)\n* `job_tags`: (string)\n* `force_handlers`: (boolean)\n* `skip_tags`: (string)\n* `start_at_task`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `use_fact_cache`: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)\n* `organization`: The organization used to determine access to this template. (id)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n* `execution_environment`: The container image to be used for execution. (id)\n* `host_config_key`: (string)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_diff_mode_on_launch`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_job_type_on_launch`: (boolean)\n* `ask_verbosity_on_launch`: (boolean)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_credential_on_launch`: (boolean)\n* `ask_execution_environment_on_launch`: (boolean)\n* `ask_labels_on_launch`: (boolean)\n* `ask_forks_on_launch`: (boolean)\n* `ask_job_slice_count_on_launch`: (boolean)\n* `ask_timeout_on_launch`: (boolean)\n* `ask_instance_groups_on_launch`: (boolean)\n* `survey_enabled`: (boolean)\n* `become_enabled`: (boolean)\n* `diff_mode`: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)\n* `allow_simultaneous`: (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `job_slice_count`: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `prevent_instance_group_fallback`: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)\n\n\n\n## Sorting\n\nTo specify that job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/JobTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/JobTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/notification_templates/": { + "get": { + "operationId": "api_organizations_notification_templates_list", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_notification_templates_create", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/notification_templates_approvals/": { + "get": { + "operationId": "api_organizations_notification_templates_approvals_list", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_notification_templates_approvals_create", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/notification_templates_error/": { + "get": { + "operationId": "api_organizations_notification_templates_error_list", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_notification_templates_error_create", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/notification_templates_started/": { + "get": { + "operationId": "api_organizations_notification_templates_started_list", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_notification_templates_started_create", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/notification_templates_success/": { + "get": { + "operationId": "api_organizations_notification_templates_success_list", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_notification_templates_success_create", + "summary": "# List Notification Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/object_roles/": { + "get": { + "operationId": "api_organizations_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for an Organization:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/projects/": { + "get": { + "operationId": "api_organizations_projects_list", + "summary": "# List Projects for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Project" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_projects_create", + "summary": "# List Projects for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Project" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Project" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/teams/": { + "get": { + "operationId": "api_organizations_teams_list", + "summary": "# List Teams for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_teams_create", + "summary": "# List Teams for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Team" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/users/": { + "get": { + "operationId": "api_organizations_users_list", + "summary": "# List Users for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_users_create", + "summary": "# List Users for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/organizations/{id}/workflow_job_templates/": { + "get": { + "operationId": "api_organizations_workflow_job_templates_list", + "summary": "# List Workflow Job Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_organizations_workflow_job_templates_create", + "summary": "# List Workflow Job Templates for an Organization:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job templates associated with the selected\norganization.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/ping/": { + "get": { + "operationId": "api_ping_list", + "summary": "Return some basic information about this instance", + "description": "Everything returned here should be considered public / insecure, as\nthis requires no auth and is intended for use by the installer process.", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/": { + "get": { + "operationId": "api_project_updates_list", + "summary": "# List Project Updates:", + "description": "Make a GET request to this resource to retrieve the list of\nproject updates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update records. \n\n## Results\n\nEach project update data structure includes the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n\n\n\n## Sorting\n\nTo specify that project updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ProjectUpdateList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/": { + "get": { + "operationId": "api_project_updates_read", + "summary": "# Retrieve a Project Update:", + "description": "Make GET request to this resource to retrieve a single project update\nrecord containing the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n\n\n\n\n\n# Delete a Project Update:\n\nMake a DELETE request to this resource to delete this project update.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectUpdateDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_project_updates_delete", + "summary": "# Retrieve a Project Update:", + "description": "Make GET request to this resource to retrieve a single project update\nrecord containing the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n* `host_status_counts`: Playbook stats from the Ansible playbook_on_stats event. (json)\n* `playbook_counts`: A count of all plays and tasks for the job run. (field)\n\n\n\n\n\n# Delete a Project Update:\n\nMake a DELETE request to this resource to delete this project update.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/cancel/": { + "get": { + "operationId": "api_project_updates_cancel_read", + "summary": "# Cancel Project Update", + "description": "Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this update can be canceled (boolean,\n read-only)\n\nMake a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectUpdateCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_project_updates_cancel_create", + "summary": "# Cancel Project Update", + "description": "Make a GET request to this resource to determine if the project update can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this update can be canceled (boolean,\n read-only)\n\nMake a POST request to this resource to cancel a pending or running project\nupdate. The response status code will be 202 if successful, or 405 if the\nupdate cannot be canceled.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ProjectUpdateCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectUpdateCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/events/": { + "get": { + "operationId": "api_project_updates_events_list", + "summary": "# List Project Update Events for a Project Update:", + "description": "Make a GET request to this resource to retrieve a list of\nproject update events associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project update events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update event records. \n\n## Results\n\nEach project update event data structure includes the following fields:\n\n* `id`: Database ID for this project update event. (integer)\n* `type`: Data type for this project update event. (choice)\n* `url`: URL for this project update event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update event was created. (datetime)\n* `modified`: Timestamp when this project update event was last modified. (datetime)\n* `event`: (choice)\n - `runner_on_failed`: Host Failed\n - `runner_on_start`: Host Started\n - `runner_on_ok`: Host OK\n - `runner_on_error`: Host Failure\n - `runner_on_skipped`: Host Skipped\n - `runner_on_unreachable`: Host Unreachable\n - `runner_on_no_hosts`: No Hosts Remaining\n - `runner_on_async_poll`: Host Polling\n - `runner_on_async_ok`: Host Async OK\n - `runner_on_async_failed`: Host Async Failure\n - `runner_item_on_ok`: Item OK\n - `runner_item_on_failed`: Item Failed\n - `runner_item_on_skipped`: Item Skipped\n - `runner_retry`: Host Retry\n - `runner_on_file_diff`: File Difference\n - `playbook_on_start`: Playbook Started\n - `playbook_on_notify`: Running Handlers\n - `playbook_on_include`: Including File\n - `playbook_on_no_hosts_matched`: No Hosts Matched\n - `playbook_on_no_hosts_remaining`: No Hosts Remaining\n - `playbook_on_task_start`: Task Started\n - `playbook_on_vars_prompt`: Variables Prompted\n - `playbook_on_setup`: Gathering Facts\n - `playbook_on_import_for_host`: internal: on Import for Host\n - `playbook_on_not_import_for_host`: internal: on Not Import for Host\n - `playbook_on_play_start`: Play Started\n - `playbook_on_stats`: Playbook Complete\n - `debug`: Debug\n - `verbose`: Verbose\n - `deprecated`: Deprecated\n - `warning`: Warning\n - `system_warning`: System Warning\n - `error`: Error\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `event_level`: (integer)\n* `failed`: (boolean)\n* `changed`: (boolean)\n* `uuid`: (string)\n* `host_name`: (field)\n* `playbook`: (string)\n* `play`: (string)\n* `task`: (string)\n* `role`: (string)\n* `stdout`: (field)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `project_update`: (id)\n\n\n\n## Sorting\n\nTo specify that project update events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ProjectUpdateEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/notifications/": { + "get": { + "operationId": "api_project_updates_notifications_list", + "summary": "# List Notifications for a Project Update:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/scm_inventory_updates/": { + "get": { + "operationId": "api_project_updates_scm_inventory_updates_list", + "summary": "# List Inventory Updates for a Project Update:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory updates associated with the selected\nproject update.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory update records. \n\n## Results\n\nEach inventory update data structure includes the following fields:\n\n* `id`: Database ID for this inventory update. (integer)\n* `type`: Data type for this inventory update. (choice)\n* `url`: URL for this inventory update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory update was created. (datetime)\n* `modified`: Timestamp when this inventory update was last modified. (datetime)\n* `name`: Name of this inventory update. (string)\n* `description`: Optional description of this inventory update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `inventory`: (id)\n* `inventory_source`: (id)\n* `license_error`: (boolean)\n* `org_host_limit_error`: (boolean)\n* `source_project_update`: Inventory files from this Project Update were used for the inventory update. (id)\n* `instance_group`: The Instance group the job was run under (id)\n* `scm_revision`: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm (string)\n\n\n\n## Sorting\n\nTo specify that inventory updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventoryUpdateList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/project_updates/{id}/stdout/": { + "get": { + "operationId": "api_project_updates_stdout_read", + "summary": "# Retrieve Project Update Stdout:", + "description": "Make GET request to this resource to retrieve the stdout from running this\nproject update.\n\n## Format\n\nUse the `format` query string parameter to specify the output format.\n\n* Browsable API: `?format=api`\n* HTML: `?format=html`\n* Plain Text: `?format=txt`\n* Plain Text with ANSI color codes: `?format=ansi`\n* JSON structure: `?format=json`\n* Downloaded Plain Text: `?format=txt_download`\n* Downloaded Plain Text with ANSI color codes: `?format=ansi_download`\n\n(_New in Ansible Tower 2.0.0_) When using the Browsable API, HTML and JSON\nformats, the `start_line` and `end_line` query string parameters can be used\nto specify a range of line numbers to retrieve.\n\nUse `dark=1` or `dark=0` as a query string parameter to force or disable a\ndark background.\n\nFiles over 1.0 MB (configurable)\nwill not display in the browser. Use the `txt_download` or `ansi_download`\nformats to download the file directly to view it.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/UnifiedJobStdout" } + } + }, + "produces": [ + "text/plain", + "text/plain", + "application/json", + "text/plain", + "text/plain" + ], + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/": { + "get": { + "operationId": "api_projects_list", + "summary": "# List Projects:", + "description": "Make a GET request to this resource to retrieve the list of\nprojects.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Project" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_create", + "summary": "# List Projects:", + "description": "Make a GET request to this resource to retrieve the list of\nprojects.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Project" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Project" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/": { + "get": { + "operationId": "api_projects_read", + "summary": "# Retrieve a Project:", + "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Project" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_projects_update", + "summary": "# Retrieve a Project:", + "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Project" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Project" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_projects_partial_update", + "summary": "# Retrieve a Project:", + "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Project" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Project" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_projects_delete", + "summary": "# Retrieve a Project:", + "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n\n\n# Update a Project:\n\nMake a PUT or PATCH request to this resource to update this\nproject. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this project. (string, required)\n* `description`: Optional description of this project. (string, default=`\"\"`)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=`\"\"`)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual (default)\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string, default=`\"\"`)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string, default=`\"\"`)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string, default=`\"\"`)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean, default=`False`)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean, default=`False`)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean, default=`False`)\n* `credential`: (id, default=``)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer, default=`0`)\n\n\n\n\n\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean, default=`False`)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=`0`)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=`False`)\n\n* `default_environment`: The default execution environment for jobs run using this project. (id, default=``)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id, default=``)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Project:\n\nMake a DELETE request to this resource to delete this project.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/access_list/": { + "get": { + "operationId": "api_projects_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/activity_stream/": { + "get": { + "operationId": "api_projects_activity_stream_list", + "summary": "# List Activity Streams for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/copy/": { + "get": { + "operationId": "api_projects_copy_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_copy_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/inventories/": { + "get": { + "operationId": "api_projects_inventories_read", + "summary": "# Retrieve a Project:", + "description": "Make GET request to this resource to retrieve a single project\nrecord containing the following fields:\n\n* `inventory_files`: Array of inventory files and directories available within this project, not comprehensive. (json)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectInventories" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/notification_templates_error/": { + "get": { + "operationId": "api_projects_notification_templates_error_list", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_notification_templates_error_create", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/notification_templates_started/": { + "get": { + "operationId": "api_projects_notification_templates_started_list", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_notification_templates_started_create", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/notification_templates_success/": { + "get": { + "operationId": "api_projects_notification_templates_success_list", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_notification_templates_success_create", + "summary": "# List Notification Templates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/object_roles/": { + "get": { + "operationId": "api_projects_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Project:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/playbooks/": { + "get": { + "operationId": "api_projects_playbooks_read", + "summary": "# Retrieve Project Playbooks:", + "description": "Make GET request to this resource to retrieve a list of playbooks available\nfor a project.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectPlaybooks" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/project_updates/": { + "get": { + "operationId": "api_projects_project_updates_list", + "summary": "# List Project Updates for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nproject updates associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of project updates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project update records. \n\n## Results\n\nEach project update data structure includes the following fields:\n\n* `id`: Database ID for this project update. (integer)\n* `type`: Data type for this project update. (choice)\n* `url`: URL for this project update. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project update was created. (datetime)\n* `modified`: Timestamp when this project update was last modified. (datetime)\n* `name`: Name of this project update. (string)\n* `description`: Optional description of this project update. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The SCM Revision discovered by this update for the given project and branch. (string)\n* `project`: (id)\n* `job_type`: (choice)\n - `run`: Run\n - `check`: Check\n* `job_tags`: Parts of the project update playbook that will be run. (string)\n\n\n\n## Sorting\n\nTo specify that project updates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ProjectUpdateList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/schedules/": { + "get": { + "operationId": "api_projects_schedules_list", + "summary": "# List Schedules for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_schedules_create", + "summary": "# List Schedules for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/scm_inventory_sources/": { + "get": { + "operationId": "api_projects_scm_inventory_sources_list", + "summary": "# List Inventory Sources for a Project:", + "description": "Make a GET request to this resource to retrieve a list of\ninventory sources associated with the selected\nproject.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of inventory sources\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more inventory source records. \n\n## Results\n\nEach inventory source data structure includes the following fields:\n\n* `id`: Database ID for this inventory source. (integer)\n* `type`: Data type for this inventory source. (choice)\n* `url`: URL for this inventory source. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this inventory source was created. (datetime)\n* `modified`: Timestamp when this inventory source was last modified. (datetime)\n* `name`: Name of this inventory source. (string)\n* `description`: Optional description of this inventory source. (string)\n* `source`: (choice)\n - `file`: File, Directory or Script\n - `constructed`: Template additional groups and hostvars at runtime\n - `scm`: Sourced from a Project\n - `ec2`: Amazon EC2\n - `gce`: Google Compute Engine\n - `azure_rm`: Microsoft Azure Resource Manager\n - `vmware`: VMware vCenter\n - `satellite6`: Red Hat Satellite 6\n - `openstack`: OpenStack\n - `rhv`: Red Hat Virtualization\n - `controller`: Red Hat Ansible Automation Platform\n - `insights`: Red Hat Insights\n - `terraform`: Terraform State\n - `openshift_virtualization`: OpenShift Virtualization\n* `source_path`: (string)\n* `source_vars`: Inventory source variables in YAML or JSON format. (string)\n* `scm_branch`: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. (string)\n* `credential`: Cloud credential to use for inventory updates. (integer)\n* `enabled_var`: Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) (string)\n* `enabled_value`: Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled (string)\n* `host_filter`: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. (string)\n* `overwrite`: Overwrite local groups and hosts from remote inventory source. (boolean)\n* `overwrite_vars`: Overwrite local variables from remote inventory source. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `verbosity`: (choice)\n - `0`: 0 (WARNING)\n - `1`: 1 (INFO)\n - `2`: 2 (DEBUG)\n* `limit`: Enter host, group or pattern match (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `none`: No External Source\n* `execution_environment`: The container image to be used for execution. (id)\n* `inventory`: (id)\n* `update_on_launch`: (boolean)\n* `update_cache_timeout`: (integer)\n* `source_project`: Project containing inventory file used as source. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that inventory sources are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InventorySource" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/teams/": { + "get": { + "operationId": "api_projects_teams_list", + "summary": "# List Teams:", + "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/projects/{id}/update/": { + "get": { + "operationId": "api_projects_update_read", + "summary": "# Update Project", + "description": "Make a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:\n\n* `can_update`: Flag indicating if this project can be updated (boolean,\n read-only)\n\nMake a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectUpdateView" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_projects_update_create", + "summary": "# Update Project", + "description": "Make a GET request to this resource to determine if the project can be updated\nfrom its SCM source. The response will include the following field:\n\n* `can_update`: Flag indicating if this project can be updated (boolean,\n read-only)\n\nMake a POST request to this resource to update the project. If the project\ncannot be updated, a 405 status code will be returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/ProjectUpdateView" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/ProjectUpdateView" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/receptor_addresses/": { + "get": { + "operationId": "api_receptor_addresses_list", + "summary": "# List Receptor Addresss:", + "description": "Make a GET request to this resource to retrieve the list of\nreceptor addresss.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of receptor addresss\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more receptor address records. \n\n## Results\n\nEach receptor address data structure includes the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)\n\n\n\n## Sorting\n\nTo specify that receptor addresss are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ReceptorAddress" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/receptor_addresses/{id}/": { + "get": { + "operationId": "api_receptor_addresses_read", + "summary": "# Retrieve a Receptor Address:", + "description": "Make GET request to this resource to retrieve a single receptor address\nrecord containing the following fields:\n\n* `id`: Database ID for this receptor address. (integer)\n* `url`: URL for this receptor address. (string)\n* `address`: Routable address for this instance. (string)\n* `port`: Port for the address. (integer)\n* `protocol`: Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'. (choice)\n - `tcp`: TCP\n - `ws`: WS\n - `wss`: WSS\n* `websocket_path`: Websocket path. (string)\n* `is_internal`: If True, only routable within the Kubernetes cluster. (boolean)\n* `canonical`: If True, this address is the canonical address for the instance. (boolean)\n* `instance`: (id)\n* `peers_from_control_nodes`: If True, control plane cluster nodes should automatically peer to it. (boolean)\n* `full_address`: (field)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/ReceptorAddress" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/": { + "get": { + "operationId": "api_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles:\n\nMake a GET request to this resource to retrieve the list of\nroles.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/{id}/": { + "get": { + "operationId": "api_roles_read", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# Retrieve a Role:\n\nMake GET request to this resource to retrieve a single role\nrecord containing the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Role" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/{id}/children/": { + "get": { + "operationId": "api_roles_children_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Role:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/{id}/parents/": { + "get": { + "operationId": "api_roles_parents_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Role:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/{id}/teams/": { + "get": { + "operationId": "api_roles_teams_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Teams for a Role:\n\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_roles_teams_create", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Teams for a Role:\n\nMake a GET request to this resource to retrieve a list of\nteams associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Team" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/roles/{id}/users/": { + "get": { + "operationId": "api_roles_users_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users for a Role:\n\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_roles_users_create", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users for a Role:\n\nMake a GET request to this resource to retrieve a list of\nusers associated with the selected\nrole.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/": { + "get": { + "operationId": "api_schedules_list", + "summary": "# List Schedules:", + "description": "Make a GET request to this resource to retrieve the list of\nschedules.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_schedules_create", + "summary": "# List Schedules:", + "description": "Make a GET request to this resource to retrieve the list of\nschedules.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/preview/": { + "post": { + "operationId": "api_schedules_preview_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/SchedulePreview" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/SchedulePreview" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/zoneinfo/": { + "get": { + "operationId": "api_schedules_zoneinfo_list", + "description": "", + "parameters": [], + "responses": { "200": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/{id}/": { + "get": { + "operationId": "api_schedules_read", + "summary": "# Retrieve a Schedule:", + "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_schedules_update", + "summary": "# Retrieve a Schedule:", + "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_schedules_partial_update", + "summary": "# Retrieve a Schedule:", + "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_schedules_delete", + "summary": "# Retrieve a Schedule:", + "description": "Make GET request to this resource to retrieve a single schedule\nrecord containing the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n\n\n# Update a Schedule:\n\nMake a PUT or PATCH request to this resource to update this\nschedule. The following fields may be modified:\n\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string, required)\n\n\n\n\n\n\n\n* `name`: Name of this schedule. (string, required)\n* `description`: Optional description of this schedule. (string, default=`\"\"`)\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `unified_job_template`: (id, required)\n* `enabled`: Enables processing of this schedule. (boolean, default=`True`)\n\n\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Schedule:\n\nMake a DELETE request to this resource to delete this schedule.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/{id}/credentials/": { + "get": { + "operationId": "api_schedules_credentials_list", + "summary": "# List Credentials for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_schedules_credentials_create", + "summary": "# List Credentials for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/{id}/instance_groups/": { + "get": { + "operationId": "api_schedules_instance_groups_list", + "summary": "# List Instance Groups for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_schedules_instance_groups_create", + "summary": "# List Instance Groups for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/{id}/jobs/": { + "get": { + "operationId": "api_schedules_jobs_list", + "summary": "# List Unified Jobs for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\nunified jobs associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/schedules/{id}/labels/": { + "get": { + "operationId": "api_schedules_labels_list", + "summary": "# List Labels for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_schedules_labels_create", + "summary": "# List Labels for a Schedule:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nschedule.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/settings/": { + "get": { + "operationId": "api_settings_list", + "summary": "# List Settings:", + "description": "Make a GET request to this resource to retrieve the list of\nsettings.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of settings\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more setting records. \n\n## Results\n\nEach setting data structure includes the following fields:\n\n* `url`: (string)\n* `slug`: (string)\n* `name`: (string)\n\n\n\n## Sorting\n\nTo specify that settings are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/SettingCategory" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/settings/logging/test/": { + "post": { + "operationId": "api_settings_logging_test_create", + "description": "# Test Logging Configuration", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/settings/{category_slug}/": { + "get": { + "operationId": "api_settings_read", + "summary": "# Retrieve a Setting:", + "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_settings_update", + "summary": "# Retrieve a Setting:", + "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_settings_partial_update", + "summary": "# Retrieve a Setting:", + "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SettingSingleton" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_settings_delete", + "summary": "# Retrieve a Setting:", + "description": "Make GET request to this resource to retrieve a single setting\nrecord containing the following fields:\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list)\n* `LICENSE`: The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license. (nested object)\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string)\n* `INSTALL_UUID`: (string)\n* `DEFAULT_CONTROL_PLANE_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_QUEUE_NAME`: (string)\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: ---------\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO`\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer)\n* `IS_K8S`: Indicates whether the instance is part of a kubernetes-based deployment. (boolean)\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean)\n* `PENDO_TRACKING_STATE`: Enable or Disable User Analytics Tracking. (choice)\n - `off`: Off\n - `anonymous`: Anonymous\n - `detailed`: Detailed\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean)\n* `AUTHENTICATION_BACKENDS`: List of authentication backends that are enabled based on license features and other authentication settings. (list)\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType`\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string)\n* `RADIUS_PORT`: Port of RADIUS server. (integer)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii`\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL`: Create an organization-owned application at https://github.com/organizations/<yourorg>/settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL`: Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean)\n* `SOCIAL_AUTH_SAML_CALLBACK_URL`: Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. (string)\n* `SOCIAL_AUTH_SAML_METADATA_URL`: If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. (string)\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer)\n* `NAMED_URL_FORMATS`: Read-only list of key-value pairs that shows the standard format of all available named URLs. (nested object)\n* `NAMED_URL_GRAPH_NODES`: Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources (nested object)\n\n\n\n\n\n# Update a Setting:\n\nMake a PUT or PATCH request to this resource to update this\nsetting. The following fields may be modified:\n\n\n* `ACTIVITY_STREAM_ENABLED`: Enable capturing activity for the activity stream. (boolean, required)\n* `ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC`: Enable capturing activity for the activity stream when running inventory sync. (boolean, required)\n* `ORG_ADMINS_CAN_SEE_ALL_USERS`: Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. (boolean, required)\n* `MANAGE_ORGANIZATION_AUTH`: Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. (boolean, required)\n* `TOWER_URL_BASE`: This setting is used by services like notifications to render a valid url to the service. (string, required)\n* `REMOTE_HOST_HEADERS`: HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the AAP Installation guide for more details. (list, required)\n* `PROXY_IP_ALLOWED_LIST`: If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally') (list, default=`[]`)\n* `CSRF_TRUSTED_ORIGINS`: If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. (list, default=`[]`)\n\n* `REDHAT_USERNAME`: This username is used to send data to Automation Analytics (string, default=`\"\"`)\n* `REDHAT_PASSWORD`: This password is used to send data to Automation Analytics (string, default=`\"\"`)\n* `SUBSCRIPTIONS_USERNAME`: This username is used to retrieve subscription and content information (string, default=`\"\"`)\n* `SUBSCRIPTIONS_PASSWORD`: This password is used to retrieve subscription and content information (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_URL`: This setting is used to to configure the upload URL for data collection for Automation Analytics. (string, default=`\"https://example.com\"`)\n\n\n\n* `DEFAULT_EXECUTION_ENVIRONMENT`: The Execution Environment to be used when one has not been configured for a job template. (field, default=`None`)\n* `CUSTOM_VENV_PATHS`: Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line. (list, default=`[]`)\n* `AD_HOC_COMMANDS`: List of modules allowed to be used by ad-hoc jobs. (list, default=`['command', 'shell', 'yum', 'apt', 'apt_key', 'apt_repository', 'apt_rpm', 'service', 'group', 'user', 'mount', 'ping', 'selinux', 'setup', 'win_ping', 'win_service', 'win_updates', 'win_group', 'win_user']`)\n* `ALLOW_JINJA_IN_EXTRA_VARS`: Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to "template" or "never". (choice, required)\n - `always`: Always\n - `never`: Never\n - `template`: Only On Job Template Definitions (default)\n* `AWX_ISOLATION_BASE_PATH`: The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). (string, required)\n* `AWX_ISOLATION_SHOW_PATHS`: List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. (list, default=`[]`)\n* `AWX_TASK_ENV`: Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending. (nested object, default=`{}`)\n* `AWX_RUNNER_KEEPALIVE_SECONDS`: Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. (integer, required)\n* `GALAXY_TASK_ENV`: Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git. (nested object, required)\n* `INSIGHTS_TRACKING_STATE`: Enables the service to gather data on automation and send it to Automation Analytics. (boolean, default=`False`)\n* `PROJECT_UPDATE_VVV`: Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. (boolean, required)\n* `AWX_ROLES_ENABLED`: Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_COLLECTIONS_ENABLED`: Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. (boolean, default=`True`)\n* `AWX_SHOW_PLAYBOOK_LINKS`: Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. (boolean, default=`False`)\n* `AWX_MOUNT_ISOLATED_PATHS_ON_K8S`: Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. (boolean, default=`False`)\n* `GALAXY_IGNORE_CERTS`: If set to true, certificate validation will not be done when installing content from any Galaxy server. (boolean, default=`False`)\n* `STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. (integer, required)\n* `EVENT_STDOUT_MAX_BYTES_DISPLAY`: Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated. (integer, required)\n* `MAX_WEBSOCKET_EVENT_RATE`: Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. (integer, default=`30`)\n* `SCHEDULE_MAX_JOBS`: Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. (integer, required)\n* `AWX_ANSIBLE_CALLBACK_PLUGINS`: List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line. (list, default=`[]`)\n* `DEFAULT_JOB_TIMEOUT`: Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. (integer, default=`0`)\n* `DEFAULT_JOB_IDLE_TIMEOUT`: If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. (integer, default=`0`)\n* `DEFAULT_INVENTORY_UPDATE_TIMEOUT`: Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. (integer, default=`0`)\n* `DEFAULT_PROJECT_UPDATE_TIMEOUT`: Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. (integer, default=`0`)\n* `ANSIBLE_FACT_CACHE_TIMEOUT`: Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. (integer, default=`0`)\n* `MAX_FORKS`: Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. (integer, default=`200`)\n* `LOG_AGGREGATOR_HOST`: Hostname/IP where external logs will be sent to. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PORT`: Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). (integer, default=`None`)\n* `LOG_AGGREGATOR_TYPE`: Format messages for the chosen log aggregator. (choice)\n - `None`: --------- (default)\n - `logstash`\n - `splunk`\n - `loggly`\n - `sumologic`\n - `other`\n* `LOG_AGGREGATOR_USERNAME`: Username for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PASSWORD`: Password or authentication token for external log aggregator (if required; HTTP/s only). (string, default=`\"\"`)\n* `LOG_AGGREGATOR_LOGGERS`: List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n (list, default=`['awx', 'activity_stream', 'job_events', 'system_tracking', 'broadcast_websocket']`)\n* `LOG_AGGREGATOR_INDIVIDUAL_FACTS`: If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. (boolean, default=`False`)\n* `LOG_AGGREGATOR_ENABLED`: Enable sending logs to external log aggregator. (boolean, default=`False`)\n* `LOG_AGGREGATOR_TOWER_UUID`: Useful to uniquely identify instances. (string, default=`\"\"`)\n* `LOG_AGGREGATOR_PROTOCOL`: Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. (choice)\n - `https`: HTTPS/HTTP (default)\n - `tcp`: TCP\n - `udp`: UDP\n* `LOG_AGGREGATOR_TCP_TIMEOUT`: Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. (integer, default=`5`)\n* `LOG_AGGREGATOR_VERIFY_CERT`: Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. (boolean, default=`True`)\n* `LOG_AGGREGATOR_LEVEL`: Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) (choice)\n - `DEBUG`\n - `INFO` (default)\n - `WARNING`\n - `ERROR`\n - `CRITICAL`\n* `LOG_AGGREGATOR_ACTION_QUEUE_SIZE`: Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). (integer, default=`131072`)\n* `LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB`: Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. (integer, default=`1`)\n* `LOG_AGGREGATOR_MAX_DISK_USAGE_PATH`: Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. (string, default=`\"/var/lib/awx\"`)\n* `LOG_AGGREGATOR_RSYSLOGD_DEBUG`: Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. (boolean, default=`False`)\n* `API_400_ERROR_LOG_FORMAT`: The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {<variable name>}. (string, default=`\"status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}\"`)\n* `AUTOMATION_ANALYTICS_LAST_GATHER`: (datetime, default=`None`)\n* `AUTOMATION_ANALYTICS_LAST_ENTRIES`: (string, default=`\"\"`)\n* `AUTOMATION_ANALYTICS_GATHER_INTERVAL`: Interval (in seconds) between data gathering. (integer, default=`14400`)\n\n* `BULK_JOB_MAX_LAUNCH`: Max jobs to allow bulk jobs to launch (integer, default=`100`)\n* `BULK_HOST_MAX_CREATE`: Max number of hosts to allow to be created in a single bulk action (integer, default=`100`)\n* `BULK_HOST_MAX_DELETE`: Max number of hosts to allow to be deleted in a single bulk action (integer, default=`250`)\n* `SUBSCRIPTION_USAGE_MODEL`: (choice)\n - `\"\"`: No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting (default)\n - `unique_managed_hosts`: Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes\n* `CLEANUP_HOST_METRICS_LAST_TS`: (datetime, required)\n* `HOST_METRIC_SUMMARY_TASK_LAST_TS`: (datetime, required)\n* `AWX_CLEANUP_PATHS`: Enable or Disable TMP Dir cleanup (boolean, default=`True`)\n* `AWX_REQUEST_PROFILE`: Debug web request python timing (boolean, default=`False`)\n* `DEFAULT_CONTAINER_RUN_OPTIONS`: List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug'] (list, default=`['--network', 'slirp4netns:enable_ipv6=true']`)\n* `RECEPTOR_RELEASE_WORK`: Release receptor work (boolean, default=`True`)\n* `RECEPTOR_KEEP_WORK_ON_ERROR`: Prevent receptor work from being released on when error is detected (boolean, default=`False`)\n* `SESSION_COOKIE_AGE`: Number of seconds that a user is inactive before they will need to login again. (integer, required)\n* `SESSIONS_PER_USER`: Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. (integer, required)\n* `DISABLE_LOCAL_AUTH`: Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. (boolean, required)\n* `AUTH_BASIC_ENABLED`: Enable HTTP Basic Auth for the API Browser. (boolean, required)\n* `OAUTH2_PROVIDER`: Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds. (nested object, default=`{'ACCESS_TOKEN_EXPIRE_SECONDS': 31536000000, 'AUTHORIZATION_CODE_EXPIRE_SECONDS': 600, 'REFRESH_TOKEN_EXPIRE_SECONDS': 2628000}`)\n* `ALLOW_OAUTH2_FOR_EXTERNAL_USERS`: For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. (boolean, default=`False`)\n* `LOGIN_REDIRECT_OVERRIDE`: URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. (string, default=`\"\"`)\n* `ALLOW_METRICS_FOR_ANONYMOUS_USERS`: If true, anonymous users are allowed to poll metrics. (boolean, default=`False`)\n\n* `CUSTOM_LOGIN_INFO`: If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. (string, default=`\"\"`)\n* `CUSTOM_LOGO`: To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. (string, default=`\"\"`)\n* `MAX_UI_JOB_EVENTS`: Maximum number of job events for the UI to retrieve within a single request. (integer, required)\n* `UI_LIVE_UPDATES_ENABLED`: If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. (boolean, required)\n\n* `SOCIAL_AUTH_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_USER_FIELDS`: When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login. (list, default=`None`)\n* `SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`: Enabling this setting will tell social auth to use the full Email as username instead of the full name (boolean, default=`False`)\n* `AUTH_LDAP_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_1_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_1_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_1_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_1_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_1_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_1_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_1_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_1_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_1_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_1_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_1_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_1_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_2_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_2_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_2_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_2_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_2_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_2_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_2_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_2_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_2_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_2_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_2_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_2_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_3_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_3_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_3_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_3_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_3_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_3_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_3_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_3_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_3_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_3_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_3_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_3_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_4_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_4_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_4_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_4_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_4_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_4_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_4_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_4_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_4_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_4_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_4_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_4_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_SERVER_URI`: URI to connect to LDAP server, such as "ldap://ldap.example.com:389" (non-SSL) or "ldaps://ldap.example.com:636" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_DN`: DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. (string, default=`\"\"`)\n* `AUTH_LDAP_5_BIND_PASSWORD`: Password used to bind LDAP user account. (string, default=`\"\"`)\n* `AUTH_LDAP_5_START_TLS`: Whether to enable TLS when the LDAP connection is not using SSL. (boolean, default=`False`)\n* `AUTH_LDAP_5_CONNECTION_OPTIONS`: Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set. (nested object, default=`{'OPT_REFERRALS': 0, 'OPT_NETWORK_TIMEOUT': 30}`)\n* `AUTH_LDAP_5_USER_SEARCH`: LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See the documentation for details. (list, default=`[]`)\n* `AUTH_LDAP_5_USER_DN_TEMPLATE`: Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_ATTR_MAP`: Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details. (nested object, default=`{}`)\n* `AUTH_LDAP_5_GROUP_SEARCH`: Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion. (list, default=`[]`)\n* `AUTH_LDAP_5_GROUP_TYPE`: The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups (choice)\n - `PosixGroupType`\n - `GroupOfNamesType`\n - `GroupOfUniqueNamesType`\n - `ActiveDirectoryGroupType`\n - `OrganizationalRoleGroupType`\n - `MemberDNGroupType` (default)\n - `NestedGroupOfNamesType`\n - `NestedGroupOfUniqueNamesType`\n - `NestedActiveDirectoryGroupType`\n - `NestedOrganizationalRoleGroupType`\n - `NestedMemberDNGroupType`\n - `PosixUIDGroupType`\n* `AUTH_LDAP_5_GROUP_TYPE_PARAMS`: Key value parameters to send the chosen group type init method. (nested object, default=`OrderedDict([('member_attr', 'member'), ('name_attr', 'cn')])`)\n* `AUTH_LDAP_5_REQUIRE_GROUP`: Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_DENY_GROUP`: Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. (string, default=`\"\"`)\n* `AUTH_LDAP_5_USER_FLAGS_BY_GROUP`: Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `AUTH_LDAP_5_ORGANIZATION_MAP`: Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `AUTH_LDAP_5_TEAM_MAP`: Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation. (nested object, default=`{}`)\n* `RADIUS_SERVER`: Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. (string, default=`\"\"`)\n* `RADIUS_PORT`: Port of RADIUS server. (integer, default=`1812`)\n* `RADIUS_SECRET`: Shared secret for authenticating to RADIUS server. (string, default=`\"\"`)\n* `TACACSPLUS_HOST`: Hostname of TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_PORT`: Port number of TACACS+ server. (integer, default=`49`)\n* `TACACSPLUS_SECRET`: Shared secret for authenticating to TACACS+ server. (string, default=`\"\"`)\n* `TACACSPLUS_SESSION_TIMEOUT`: TACACS+ session timeout value in seconds, 0 disables timeout. (integer, default=`5`)\n* `TACACSPLUS_AUTH_PROTOCOL`: Choose the authentication protocol used by TACACS+ client. (choice)\n - `ascii` (default)\n - `pap`\n* `TACACSPLUS_REM_ADDR`: Enable the client address sending by TACACS+ client. (boolean, default=`False`)\n\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_KEY`: The OAuth2 key from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET`: The OAuth2 secret from your web application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS`: Update this setting to restrict the domains who are allowed to login using Google OAuth2. (list, default=`[]`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS`: Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail. (nested object, default=`{}`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_KEY`: The OAuth2 key (Client ID) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_SECRET`: The OAuth2 secret (Client Secret) from your GitHub developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_NAME`: The name of your GitHub organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ID`: Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME`: The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com/<yourorg>/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL`: The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL`: The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY`: The OAuth2 key (Client ID) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET`: The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID`: Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. (string, default=`\"\"`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_KEY`: The OAuth2 key (Client ID) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET`: The OAuth2 secret (Client Secret) from your Azure AD application. (string, default=`\"\"`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_OIDC_KEY`: The OIDC key (Client ID) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_SECRET`: The OIDC secret (Client Secret) from your IDP. (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_OIDC_ENDPOINT`: The URL for your OIDC provider including the path up to /.well-known/openid-configuration (string, default=`\"\"`)\n* `SOCIAL_AUTH_OIDC_VERIFY_SSL`: Verify the OIDC provider ssl certificate. (boolean, default=`True`)\n* `SAML_AUTO_CREATE_OBJECTS`: When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. (boolean, default=`True`)\n\n\n* `SOCIAL_AUTH_SAML_SP_ENTITY_ID`: The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. (string, default=`\"\"`)\n* `SOCIAL_AUTH_SAML_SP_PUBLIC_CERT`: Create a keypair to use as a service provider (SP) and include the certificate content here. (string, required)\n* `SOCIAL_AUTH_SAML_SP_PRIVATE_KEY`: Create a keypair to use as a service provider (SP) and include the private key content here. (string, required)\n* `SOCIAL_AUTH_SAML_ORG_INFO`: Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_TECHNICAL_CONTACT`: Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_SUPPORT_CONTACT`: Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax. (nested object, required)\n* `SOCIAL_AUTH_SAML_ENABLED_IDPS`: Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_SECURITY_CONFIG`: A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings (nested object, default=`{'requestedAuthnContext': False}`)\n* `SOCIAL_AUTH_SAML_SP_EXTRA`: A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_EXTRA_DATA`: A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value. (list, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_MAP`: Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_TEAM_MAP`: Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation. (nested object, default=`None`)\n* `SOCIAL_AUTH_SAML_ORGANIZATION_ATTR`: Used to translate user organization membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_TEAM_ATTR`: Used to translate user team membership. (nested object, default=`{}`)\n* `SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR`: Used to map super users and system auditors from SAML. (nested object, default=`{}`)\n* `LOCAL_PASSWORD_MIN_LENGTH`: Minimum number of characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_DIGITS`: Minimum number of digit characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_UPPER`: Minimum number of uppercase characters required in a local password. 0 means no minimum (integer, default=`0`)\n* `LOCAL_PASSWORD_MIN_SPECIAL`: Minimum number of special characters required in a local password. 0 means no minimum (integer, default=`0`)\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Setting:\n\nMake a DELETE request to this resource to delete this setting.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { + "name": "category_slug", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "/api/{version}/system_job_templates/": { + "get": { + "operationId": "api_system_job_templates_list", + "summary": "# List System Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nsystem job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job template records. \n\n## Results\n\nEach system job template data structure includes the following fields:\n\n* `id`: Database ID for this system job template. (integer)\n* `type`: Data type for this system job template. (choice)\n* `url`: URL for this system job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job template was created. (datetime)\n* `modified`: Timestamp when this system job template was last modified. (datetime)\n* `name`: Name of this system job template. (string)\n* `description`: Optional description of this system job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n\n\n\n## Sorting\n\nTo specify that system job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/SystemJobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/": { + "get": { + "operationId": "api_system_job_templates_read", + "summary": "# Retrieve a System Job Template:", + "description": "Make GET request to this resource to retrieve a single system job template\nrecord containing the following fields:\n\n* `id`: Database ID for this system job template. (integer)\n* `type`: Data type for this system job template. (choice)\n* `url`: URL for this system job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job template was created. (datetime)\n* `modified`: Timestamp when this system job template was last modified. (datetime)\n* `name`: Name of this system job template. (string)\n* `description`: Optional description of this system job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SystemJobTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/jobs/": { + "get": { + "operationId": "api_system_job_templates_jobs_list", + "summary": "# List System Jobs for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nsystem jobs associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job records. \n\n## Results\n\nEach system job data structure includes the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n## Sorting\n\nTo specify that system jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/SystemJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/launch/": { + "get": { + "operationId": "api_system_job_templates_launch_list", + "summary": "Launch a Job Template:", + "description": "Make a POST request to this resource to launch the system job template.\n\nVariables specified inside of the parameter `extra_vars` are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the `awx-manage` command.\n\nFor example on `cleanup_jobs` and `cleanup_activitystream`:\n\n`{\"extra_vars\": {\"days\": 30}}`\n\nWhich will act on data older than 30 days.\n\nFor `cleanup_activitystream` and `cleanup_jobs` commands, providing\n`\"dry_run\": true` inside of `extra_vars` will show items that will be\nremoved without deleting them.\n\nEach individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty `extra_vars`.\n\n - Defaults for `cleanup_activitystream`: days=90\n - Defaults for `cleanup_jobs`: days=90\n\nIf successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_job_templates_launch_create", + "summary": "Launch a Job Template:", + "description": "Make a POST request to this resource to launch the system job template.\n\nVariables specified inside of the parameter `extra_vars` are passed to the\nsystem job task as command line parameters. These tasks can be run manually\non the host system via the `awx-manage` command.\n\nFor example on `cleanup_jobs` and `cleanup_activitystream`:\n\n`{\"extra_vars\": {\"days\": 30}}`\n\nWhich will act on data older than 30 days.\n\nFor `cleanup_activitystream` and `cleanup_jobs` commands, providing\n`\"dry_run\": true` inside of `extra_vars` will show items that will be\nremoved without deleting them.\n\nEach individual system job task has its own default values, which are\napplicable either when running it from the command line or launching its\nsystem job template with empty `extra_vars`.\n\n - Defaults for `cleanup_activitystream`: days=90\n - Defaults for `cleanup_jobs`: days=90\n\nIf successful, the response status code will be 202. If the job cannot be\nlaunched, a 405 status code will be returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/notification_templates_error/": { + "get": { + "operationId": "api_system_job_templates_notification_templates_error_list", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_job_templates_notification_templates_error_create", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/notification_templates_started/": { + "get": { + "operationId": "api_system_job_templates_notification_templates_started_list", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_job_templates_notification_templates_started_create", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/notification_templates_success/": { + "get": { + "operationId": "api_system_job_templates_notification_templates_success_list", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_job_templates_notification_templates_success_create", + "summary": "# List Notification Templates for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_job_templates/{id}/schedules/": { + "get": { + "operationId": "api_system_job_templates_schedules_list", + "summary": "# List Schedules for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_job_templates_schedules_create", + "summary": "# List Schedules for a System Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nsystem job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_jobs/": { + "get": { + "operationId": "api_system_jobs_list", + "summary": "# List System Jobs:", + "description": "Make a GET request to this resource to retrieve the list of\nsystem jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job records. \n\n## Results\n\nEach system job data structure includes the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n## Sorting\n\nTo specify that system jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/SystemJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_jobs/{id}/": { + "get": { + "operationId": "api_system_jobs_read", + "summary": "# Retrieve a System Job:", + "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n\n\n# Delete a System Job:\n\nMake a DELETE request to this resource to delete this system job.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SystemJob" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_system_jobs_delete", + "summary": "# Retrieve a System Job:", + "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `id`: Database ID for this system job. (integer)\n* `type`: Data type for this system job. (choice)\n* `url`: URL for this system job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job was created. (datetime)\n* `modified`: Timestamp when this system job was last modified. (datetime)\n* `name`: Name of this system job. (string)\n* `description`: Optional description of this system job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `system_job_template`: (id)\n* `job_type`: (choice)\n - `\"\"`: ---------\n - `cleanup_jobs`: Remove jobs older than a certain number of days\n - `cleanup_activitystream`: Remove activity stream entries older than a certain number of days\n - `cleanup_sessions`: Removes expired browser sessions from the database\n - `cleanup_tokens`: Removes expired OAuth 2 access tokens and refresh tokens\n* `extra_vars`: (string)\n* `result_stdout`: (field)\n\n\n\n\n\n# Delete a System Job:\n\nMake a DELETE request to this resource to delete this system job.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_jobs/{id}/cancel/": { + "get": { + "operationId": "api_system_jobs_cancel_read", + "summary": "# Retrieve a System Job:", + "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/SystemJobCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_system_jobs_cancel_create", + "summary": "# Retrieve a System Job:", + "description": "Make GET request to this resource to retrieve a single system job\nrecord containing the following fields:\n\n* `can_cancel`: (boolean)", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/SystemJobCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/SystemJobCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_jobs/{id}/events/": { + "get": { + "operationId": "api_system_jobs_events_list", + "summary": "# List System Job Events for a System Job:", + "description": "Make a GET request to this resource to retrieve a list of\nsystem job events associated with the selected\nsystem job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of system job events\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more system job event records. \n\n## Results\n\nEach system job event data structure includes the following fields:\n\n* `id`: Database ID for this system job event. (integer)\n* `type`: Data type for this system job event. (choice)\n* `url`: URL for this system job event. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this system job event was created. (datetime)\n* `modified`: Timestamp when this system job event was last modified. (datetime)\n* `event`: (field)\n* `counter`: (integer)\n* `event_display`: (string)\n* `event_data`: (json)\n* `failed`: (field)\n* `changed`: (field)\n* `uuid`: (string)\n* `stdout`: (string)\n* `start_line`: (integer)\n* `end_line`: (integer)\n* `verbosity`: (integer)\n* `system_job`: (id)\n\n\n\n## Sorting\n\nTo specify that system job events are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/SystemJobEvent" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/system_jobs/{id}/notifications/": { + "get": { + "operationId": "api_system_jobs_notifications_list", + "summary": "# List Notifications for a System Job:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nsystem job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/": { + "get": { + "operationId": "api_teams_list", + "summary": "# List Teams:", + "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_teams_create", + "summary": "# List Teams:", + "description": "Make a GET request to this resource to retrieve the list of\nteams.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Team" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/": { + "get": { + "operationId": "api_teams_read", + "summary": "# Retrieve a Team:", + "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_teams_update", + "summary": "# Retrieve a Team:", + "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Team" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_teams_partial_update", + "summary": "# Retrieve a Team:", + "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Team" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/Team" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_teams_delete", + "summary": "# Retrieve a Team:", + "description": "Make GET request to this resource to retrieve a single team\nrecord containing the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n\n\n# Update a Team:\n\nMake a PUT or PATCH request to this resource to update this\nteam. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this team. (string, required)\n* `description`: Optional description of this team. (string, default=`\"\"`)\n* `organization`: (id, required)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Team:\n\nMake a DELETE request to this resource to delete this team.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/access_list/": { + "get": { + "operationId": "api_teams_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/activity_stream/": { + "get": { + "operationId": "api_teams_activity_stream_list", + "summary": "# List Activity Streams for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/credentials/": { + "get": { + "operationId": "api_teams_credentials_list", + "summary": "# List Credentials for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/TeamCredentialSerializerCreate" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_teams_credentials_create", + "summary": "# List Credentials for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/TeamCredentialSerializerCreate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/TeamCredentialSerializerCreate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/object_roles/": { + "get": { + "operationId": "api_teams_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/projects/": { + "get": { + "operationId": "api_teams_projects_list", + "summary": "# List Projects for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Project" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/roles/": { + "get": { + "operationId": "api_teams_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected team.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleSerializerWithParentAccess" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_teams_roles_create", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Team:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected team.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleSerializerWithParentAccess" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/RoleSerializerWithParentAccess" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/teams/{id}/users/": { + "get": { + "operationId": "api_teams_users_list", + "summary": "# List Users for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_teams_users_create", + "summary": "# List Users for a Team:", + "description": "Make a GET request to this resource to retrieve a list of\nusers associated with the selected\nteam.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/tokens/": { + "get": { + "operationId": "api_tokens_list", + "summary": "# List Access Tokens:", + "description": "Make a GET request to this resource to retrieve the list of\naccess tokens.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Token" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_tokens_create", + "summary": "# List Access Tokens:", + "description": "Make a GET request to this resource to retrieve the list of\naccess tokens.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/tokens/{id}/": { + "get": { + "operationId": "api_tokens_read", + "summary": "# Retrieve an Access Token:", + "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2TokenDetail" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_tokens_update", + "summary": "# Retrieve an Access Token:", + "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2TokenDetail" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2TokenDetail" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_tokens_partial_update", + "summary": "# Retrieve an Access Token:", + "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2TokenDetail" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2TokenDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_tokens_delete", + "summary": "# Retrieve an Access Token:", + "description": "Make GET request to this resource to retrieve a single access token\nrecord containing the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n\n\n# Update an Access Token:\n\nMake a PUT or PATCH request to this resource to update this\naccess token. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `description`: Optional description of this access token. (string, default=`\"\"`)\n\n\n\n\n\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default=`\"write\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete an Access Token:\n\nMake a DELETE request to this resource to delete this access token.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/tokens/{id}/activity_stream/": { + "get": { + "operationId": "api_tokens_activity_stream_list", + "summary": "# List Activity Streams for an Access Token:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\naccess token.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/unified_job_templates/": { + "get": { + "operationId": "api_unified_job_templates_list", + "summary": "# List Unified Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nunified job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job template records. \n\n## Results\n\nEach unified job template data structure includes the following fields:\n\n* `id`: Database ID for this unified job template. (integer)\n* `type`: Data type for this unified job template. (choice)\n* `url`: URL for this unified job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job template was created. (datetime)\n* `modified`: Timestamp when this unified job template was last modified. (datetime)\n* `name`: Name of this unified job template. (string)\n* `description`: Optional description of this unified job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n\n\n\n## Sorting\n\nTo specify that unified job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/unified_jobs/": { + "get": { + "operationId": "api_unified_jobs_list", + "summary": "# List Unified Jobs:", + "description": "Make a GET request to this resource to retrieve the list of\nunified jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of unified jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more unified job records. \n\n## Results\n\nEach unified job data structure includes the following fields:\n\n* `id`: Database ID for this unified job. (integer)\n* `type`: Data type for this unified job. (choice)\n* `url`: URL for this unified job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this unified job was created. (datetime)\n* `modified`: Timestamp when this unified job was last modified. (datetime)\n* `name`: Name of this unified job. (string)\n* `description`: Optional description of this unified job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `execution_node`: The node the job executed on. (string)\n* `controller_node`: The instance that managed the execution environment. (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n\n\n\n## Sorting\n\nTo specify that unified jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UnifiedJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/": { + "get": { + "operationId": "api_users_list", + "summary": "# List Users:", + "description": "Make a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/User" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_create", + "summary": "# List Users:", + "description": "Make a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/": { + "get": { + "operationId": "api_users_read", + "summary": "# Retrieve a User:", + "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_users_update", + "summary": "# Retrieve a User:", + "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_users_partial_update", + "summary": "# Retrieve a User:", + "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/User" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/User" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_users_delete", + "summary": "# Retrieve a User:", + "description": "Make GET request to this resource to retrieve a single user\nrecord containing the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n\n\n# Update a User:\n\nMake a PUT or PATCH request to this resource to update this\nuser. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)\n* `first_name`: (string, default=`\"\"`)\n* `last_name`: (string, default=`\"\"`)\n* `email`: (string, default=`\"\"`)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean, default=`False`)\n* `is_system_auditor`: (boolean, default=`False`)\n* `password`: Field used to change the password. (string, default=`\"\"`)\n\n\n\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a User:\n\nMake a DELETE request to this resource to delete this user.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/access_list/": { + "get": { + "operationId": "api_users_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/activity_stream/": { + "get": { + "operationId": "api_users_activity_stream_list", + "summary": "# List Activity Streams for a User:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/admin_of_organizations/": { + "get": { + "operationId": "api_users_admin_of_organizations_list", + "summary": "# List Organizations Administered by this User:", + "description": "Make a GET request to this resource to retrieve a list of\norganizations of which the selected\nuser is an admin.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Organization" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/applications/": { + "get": { + "operationId": "api_users_applications_list", + "summary": "# List Applications:", + "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Application" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_applications_create", + "summary": "# List Applications:", + "description": "Make a GET request to this resource to retrieve the list of\napplications.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of applications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more application records. \n\n## Results\n\nEach application data structure includes the following fields:\n\n* `id`: Database ID for this application. (integer)\n* `type`: Data type for this application. (choice)\n* `url`: URL for this application. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this application was created. (datetime)\n* `modified`: Timestamp when this application was last modified. (datetime)\n* `name`: Name of this application. (string)\n* `description`: Optional description of this application. (string)\n* `client_id`: (string)\n* `client_secret`: Used for more stringent verification of access to an application when creating a token. (string)\n* `client_type`: Set to Public or Confidential depending on how secure the client device is. (choice)\n - `confidential`: Confidential\n - `public`: Public\n* `redirect_uris`: Allowed URIs list, space separated (string)\n* `authorization_grant_type`: The Grant type the user must use for acquire tokens for this application. (choice)\n - `authorization-code`: Authorization code\n - `password`: Resource owner password-based\n* `skip_authorization`: Set True to skip authorization step for completely trusted applications. (boolean)\n* `organization`: Organization containing this application. (id)\n\n\n\n## Sorting\n\nTo specify that applications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Application" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/authorized_tokens/": { + "get": { + "operationId": "api_users_authorized_tokens_list", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UserAuthorizedToken" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_authorized_tokens_create", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/UserAuthorizedToken" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/UserAuthorizedToken" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/credentials/": { + "get": { + "operationId": "api_users_credentials_list", + "summary": "# List Credentials for a User:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/UserCredentialSerializerCreate" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_credentials_create", + "summary": "# List Credentials for a User:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/UserCredentialSerializerCreate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/UserCredentialSerializerCreate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/organizations/": { + "get": { + "operationId": "api_users_organizations_list", + "summary": "# List Organizations for a User:", + "description": "Make a GET request to this resource to retrieve a list of\norganizations associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of organizations\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more organization records. \n\n## Results\n\nEach organization data structure includes the following fields:\n\n* `id`: Database ID for this organization. (integer)\n* `type`: Data type for this organization. (choice)\n* `url`: URL for this organization. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this organization was created. (datetime)\n* `modified`: Timestamp when this organization was last modified. (datetime)\n* `name`: Name of this organization. (string)\n* `description`: Optional description of this organization. (string)\n* `max_hosts`: Maximum number of hosts allowed to be managed by this organization. (integer)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run by this organization. (id)\n\n\n\n## Sorting\n\nTo specify that organizations are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Organization" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/personal_tokens/": { + "get": { + "operationId": "api_users_personal_tokens_list", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/UserPersonalToken" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_personal_tokens_create", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/UserPersonalToken" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/UserPersonalToken" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/projects/": { + "get": { + "operationId": "api_users_projects_list", + "summary": "# List Projects for a User:", + "description": "Make a GET request to this resource to retrieve a list of\nprojects associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of projects\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more project records. \n\n## Results\n\nEach project data structure includes the following fields:\n\n* `id`: Database ID for this project. (integer)\n* `type`: Data type for this project. (choice)\n* `url`: URL for this project. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this project was created. (datetime)\n* `modified`: Timestamp when this project was last modified. (datetime)\n* `name`: Name of this project. (string)\n* `description`: Optional description of this project. (string)\n* `local_path`: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)\n* `scm_type`: Specifies the source control system used to store the project. (choice)\n - `\"\"`: Manual\n - `git`: Git\n - `svn`: Subversion\n - `insights`: Red Hat Insights\n - `archive`: Remote Archive\n* `scm_url`: The location where the project is stored. (string)\n* `scm_branch`: Specific branch, tag or commit to checkout. (string)\n* `scm_refspec`: For git projects, an additional refspec to fetch. (string)\n* `scm_clean`: Discard any local changes before syncing the project. (boolean)\n* `scm_track_submodules`: Track submodules latest commits on defined branch. (boolean)\n* `scm_delete_on_update`: Delete the project before syncing. (boolean)\n* `credential`: (id)\n* `timeout`: The amount of time (in seconds) to run before the task is canceled. (integer)\n* `scm_revision`: The last revision fetched by a project update (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n* `organization`: The organization used to determine access to this template. (id)\n* `scm_update_on_launch`: Update the project when a job is launched that uses the project. (boolean)\n* `scm_update_cache_timeout`: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)\n* `allow_override`: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)\n* `custom_virtualenv`: Local absolute file path containing a custom Python virtualenv to use (string)\n* `default_environment`: The default execution environment for jobs run using this project. (id)\n* `signature_validation_credential`: An optional credential used for validating files in the project against unexpected changes. (id)\n* `last_update_failed`: (boolean)\n* `last_updated`: (datetime)\n\n\n\n## Sorting\n\nTo specify that projects are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Project" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/roles/": { + "get": { + "operationId": "api_users_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a User:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected user.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleSerializerWithParentAccess" + } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_roles_create", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a User:\n\nMake a GET request to this resource to retrieve a list of roles associated with the selected user.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/RoleSerializerWithParentAccess" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/RoleSerializerWithParentAccess" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/teams/": { + "get": { + "operationId": "api_users_teams_list", + "summary": "# List Teams for a User:", + "description": "Make a GET request to this resource to retrieve a list of\nteams associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of teams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more team records. \n\n## Results\n\nEach team data structure includes the following fields:\n\n* `id`: Database ID for this team. (integer)\n* `type`: Data type for this team. (choice)\n* `url`: URL for this team. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this team was created. (datetime)\n* `modified`: Timestamp when this team was last modified. (datetime)\n* `name`: Name of this team. (string)\n* `description`: Optional description of this team. (string)\n* `organization`: (id)\n\n\n\n## Sorting\n\nTo specify that teams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Team" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/users/{id}/tokens/": { + "get": { + "operationId": "api_users_tokens_list", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/OAuth2Token" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_users_tokens_create", + "summary": "# List Access Tokens for a User:", + "description": "Make a GET request to this resource to retrieve a list of\naccess tokens associated with the selected\nuser.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of access tokens\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more access token records. \n\n## Results\n\nEach access token data structure includes the following fields:\n\n* `id`: Database ID for this access token. (integer)\n* `type`: Data type for this access token. (choice)\n* `url`: URL for this access token. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this access token was created. (datetime)\n* `modified`: Timestamp when this access token was last modified. (datetime)\n* `description`: Optional description of this access token. (string)\n* `user`: The user representing the token owner (id)\n* `token`: (string)\n* `refresh_token`: (field)\n* `application`: (id)\n* `expires`: (datetime)\n* `scope`: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)\n\n\n\n## Sorting\n\nTo specify that access tokens are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/OAuth2Token" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approval_templates/{id}/": { + "get": { + "operationId": "api_workflow_approval_templates_read", + "summary": "# Retrieve a Workflow Approval Template:", + "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalTemplate" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_workflow_approval_templates_update", + "summary": "# Retrieve a Workflow Approval Template:", + "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowApprovalTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalTemplate" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_workflow_approval_templates_partial_update", + "summary": "# Retrieve a Workflow Approval Template:", + "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowApprovalTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalTemplate" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_approval_templates_delete", + "summary": "# Retrieve a Workflow Approval Template:", + "description": "Make GET request to this resource to retrieve a single workflow approval template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval template. (integer)\n* `type`: Data type for this workflow approval template. (choice)\n* `url`: URL for this workflow approval template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval template was created. (datetime)\n* `modified`: Timestamp when this workflow approval template was last modified. (datetime)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `execution_environment`: The container image to be used for execution. (id)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n\n\n\n\n\n# Update a Workflow Approval Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow approval template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow approval template. (string, required)\n* `description`: Optional description of this workflow approval template. (string, default=`\"\"`)\n\n\n\n\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer, default=`0`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Approval Template:\n\nMake a DELETE request to this resource to delete this workflow approval template.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approval_templates/{id}/approvals/": { + "get": { + "operationId": "api_workflow_approval_templates_approvals_list", + "summary": "# List Workflow Approvals for a Workflow Approval Template:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow approvals associated with the selected\nworkflow approval template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow approvals\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow approval records. \n\n## Results\n\nEach workflow approval data structure includes the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n## Sorting\n\nTo specify that workflow approvals are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowApprovalList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approvals/": { + "get": { + "operationId": "api_workflow_approvals_list", + "summary": "# List Workflow Approvals:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow approvals.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow approvals\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow approval records. \n\n## Results\n\nEach workflow approval data structure includes the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n## Sorting\n\nTo specify that workflow approvals are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowApprovalList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approvals/{id}/": { + "get": { + "operationId": "api_workflow_approvals_read", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n\n\n# Delete a Workflow Approval:\n\nMake a DELETE request to this resource to delete this workflow approval.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApproval" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_approvals_delete", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow approval. (integer)\n* `type`: Data type for this workflow approval. (choice)\n* `url`: URL for this workflow approval. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow approval was created. (datetime)\n* `modified`: Timestamp when this workflow approval was last modified. (datetime)\n* `name`: Name of this workflow approval. (string)\n* `description`: Optional description of this workflow approval. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `execution_environment`: The container image to be used for execution. (id)\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `event_processing_finished`: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `can_approve_or_deny`: (field)\n* `approval_expiration`: (field)\n* `timed_out`: (boolean)\n\n\n\n\n\n# Delete a Workflow Approval:\n\nMake a DELETE request to this resource to delete this workflow approval.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approvals/{id}/approve/": { + "get": { + "operationId": "api_workflow_approvals_approve_read", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_approvals_approve_create", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_approvals/{id}/deny/": { + "get": { + "operationId": "api_workflow_approvals_deny_read", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_approvals_deny_create", + "summary": "# Retrieve a Workflow Approval:", + "description": "Make GET request to this resource to retrieve a single workflow approval\nrecord containing the following fields:", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowApprovalView" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/": { + "get": { + "operationId": "api_workflow_job_nodes_list", + "summary": "# List Workflow Job Nodes:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow job nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobNodeList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/": { + "get": { + "operationId": "api_workflow_job_nodes_read", + "summary": "# Retrieve a Workflow Job Node:", + "description": "Make GET request to this resource to retrieve a single workflow job node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobNodeDetail" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/always_nodes/": { + "get": { + "operationId": "api_workflow_job_nodes_always_nodes_list", + "summary": "# List Workflow Job Nodes for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobNodeList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/credentials/": { + "get": { + "operationId": "api_workflow_job_nodes_credentials_list", + "summary": "# List Credentials for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/failure_nodes/": { + "get": { + "operationId": "api_workflow_job_nodes_failure_nodes_list", + "summary": "# List Workflow Job Nodes for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobNodeList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/instance_groups/": { + "get": { + "operationId": "api_workflow_job_nodes_instance_groups_list", + "summary": "# List Instance Groups for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_nodes_instance_groups_create", + "summary": "# List Instance Groups for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/labels/": { + "get": { + "operationId": "api_workflow_job_nodes_labels_list", + "summary": "# List Labels for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_nodes/{id}/success_nodes/": { + "get": { + "operationId": "api_workflow_job_nodes_success_nodes_list", + "summary": "# List Workflow Job Nodes for a Workflow Job Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobNodeList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/": { + "get": { + "operationId": "api_workflow_job_template_nodes_list", + "summary": "# List Workflow Job Template Nodes:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow job template nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_create", + "summary": "# List Workflow Job Template Nodes:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow job template nodes.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/": { + "get": { + "operationId": "api_workflow_job_template_nodes_read", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNodeDetail" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_workflow_job_template_nodes_update", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNodeDetail" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNodeDetail" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_workflow_job_template_nodes_partial_update", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNodeDetail" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNodeDetail" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_job_template_nodes_delete", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n\n\n# Update a Workflow Job Template Node:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template node. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `extra_data`: (json, default=`{}`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `scm_branch`: (string, default=`\"\"`)\n* `job_type`: (choice)\n - `None`: --------- (default)\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string, default=`\"\"`)\n* `skip_tags`: (string, default=`\"\"`)\n* `limit`: (string, default=`\"\"`)\n* `diff_mode`: (boolean, default=`None`)\n* `verbosity`: (choice)\n - `None`: --------- (default)\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id, default=``)\n* `forks`: (integer, default=`None`)\n* `job_slice_count`: (integer, default=`None`)\n* `timeout`: (integer, default=`None`)\n* `workflow_job_template`: (id, required)\n* `unified_job_template`: (id, default=``)\n\n\n\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=`False`)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default=`\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template Node:\n\nMake a DELETE request to this resource to delete this workflow job template node.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/always_nodes/": { + "get": { + "operationId": "api_workflow_job_template_nodes_always_nodes_list", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_always_nodes_create", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/create_approval_template/": { + "get": { + "operationId": "api_workflow_job_template_nodes_create_approval_template_read", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval" + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_create_approval_template_create", + "summary": "# Retrieve a Workflow Job Template Node:", + "description": "Make GET request to this resource to retrieve a single workflow job template node\nrecord containing the following fields:\n\n* `timeout`: The amount of time (in seconds) before the approval node expires and fails. (integer)\n* `name`: Name of this workflow approval template. (string)\n* `description`: Optional description of this workflow approval template. (string)", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval" + } + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkflowJobTemplateNodeCreateApproval" + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/credentials/": { + "get": { + "operationId": "api_workflow_job_template_nodes_credentials_list", + "summary": "# List Credentials for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Credential" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_credentials_create", + "summary": "# List Credentials for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\ncredentials associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of credentials\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more credential records. \n\n## Results\n\nEach credential data structure includes the following fields:\n\n* `id`: Database ID for this credential. (integer)\n* `type`: Data type for this credential. (choice)\n* `url`: URL for this credential. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this credential was created. (datetime)\n* `modified`: Timestamp when this credential was last modified. (datetime)\n* `name`: Name of this credential. (string)\n* `description`: Optional description of this credential. (string)\n* `organization`: (id)\n* `credential_type`: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)\n* `managed`: (boolean)\n* `inputs`: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)\n* `kind`: (field)\n* `cloud`: (field)\n* `kubernetes`: (field)\n\n\n\n## Sorting\n\nTo specify that credentials are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Credential" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Credential" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/failure_nodes/": { + "get": { + "operationId": "api_workflow_job_template_nodes_failure_nodes_list", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_failure_nodes_create", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/instance_groups/": { + "get": { + "operationId": "api_workflow_job_template_nodes_instance_groups_list", + "summary": "# List Instance Groups for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/InstanceGroup" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_instance_groups_create", + "summary": "# List Instance Groups for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\ninstance groups associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of instance groups\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more instance group records. \n\n## Results\n\nEach instance group data structure includes the following fields:\n\n* `id`: Database ID for this instance group. (integer)\n* `type`: Data type for this instance group. (choice)\n* `url`: URL for this instance group. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `name`: Name of this instance group. (string)\n* `created`: Timestamp when this instance group was created. (datetime)\n* `modified`: Timestamp when this instance group was last modified. (datetime)\n* `capacity`: (field)\n* `consumed_capacity`: (field)\n* `percent_capacity_remaining`: (field)\n* `jobs_running`: (field)\n* `max_concurrent_jobs`: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer)\n* `max_forks`: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer)\n* `jobs_total`: Count of all jobs that target this instance group (integer)\n* `instances`: (field)\n* `is_container_group`: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)\n* `credential`: (id)\n* `policy_instance_percentage`: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)\n* `policy_instance_minimum`: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)\n* `policy_instance_list`: List of exact-match Instances that will be assigned to this group (json)\n* `pod_spec_override`: (string)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n\n\n\n## Sorting\n\nTo specify that instance groups are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/InstanceGroup" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/labels/": { + "get": { + "operationId": "api_workflow_job_template_nodes_labels_list", + "summary": "# List Labels for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_labels_create", + "summary": "# List Labels for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_template_nodes/{id}/success_nodes/": { + "get": { + "operationId": "api_workflow_job_template_nodes_success_nodes_list", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_template_nodes_success_nodes_create", + "summary": "# List Workflow Job Template Nodes for a Workflow Job Template Node:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template node.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/": { + "get": { + "operationId": "api_workflow_job_templates_list", + "summary": "# List Workflow Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_create", + "summary": "# List Workflow Job Templates:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow job templates.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template records. \n\n## Results\n\nEach workflow job template data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow job templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/": { + "get": { + "operationId": "api_workflow_job_templates_read", + "summary": "# Retrieve a Workflow Job Template:", + "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + }, + "tags": ["api"] + }, + "put": { + "operationId": "api_workflow_job_templates_update", + "summary": "# Retrieve a Workflow Job Template:", + "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + }, + "tags": ["api"] + }, + "patch": { + "operationId": "api_workflow_job_templates_partial_update", + "summary": "# Retrieve a Workflow Job Template:", + "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + ], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplate" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_job_templates_delete", + "summary": "# Retrieve a Workflow Job Template:", + "description": "Make GET request to this resource to retrieve a single workflow job template\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job template. (integer)\n* `type`: Data type for this workflow job template. (choice)\n* `url`: URL for this workflow job template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template was created. (datetime)\n* `modified`: Timestamp when this workflow job template was last modified. (datetime)\n* `name`: Name of this workflow job template. (string)\n* `description`: Optional description of this workflow job template. (string)\n* `last_job_run`: (datetime)\n* `last_job_failed`: (boolean)\n* `next_job_run`: (datetime)\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n - `never updated`: Never Updated\n - `ok`: OK\n - `missing`: Missing\n - `none`: No External Source\n - `updating`: Updating\n* `extra_vars`: (json)\n* `organization`: The organization used to determine access to this template. (id)\n* `survey_enabled`: (boolean)\n* `allow_simultaneous`: (boolean)\n* `ask_variables_on_launch`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `ask_inventory_on_launch`: (boolean)\n* `ask_scm_branch_on_launch`: (boolean)\n* `ask_limit_on_launch`: (boolean)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `ask_labels_on_launch`: (boolean)\n* `ask_skip_tags_on_launch`: (boolean)\n* `ask_tags_on_launch`: (boolean)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Update a Workflow Job Template:\n\nMake a PUT or PATCH request to this resource to update this\nworkflow job template. The following fields may be modified:\n\n\n\n\n\n\n\n\n\n* `name`: Name of this workflow job template. (string, required)\n* `description`: Optional description of this workflow job template. (string, default=`\"\"`)\n\n\n\n\n* `extra_vars`: (json, default=``)\n* `organization`: The organization used to determine access to this template. (id, default=``)\n* `survey_enabled`: (boolean, default=`False`)\n* `allow_simultaneous`: (boolean, default=`False`)\n* `ask_variables_on_launch`: (boolean, default=`False`)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)\n* `limit`: (string, default=`\"\"`)\n* `scm_branch`: (string, default=`\"\"`)\n* `ask_inventory_on_launch`: (boolean, default=`False`)\n* `ask_scm_branch_on_launch`: (boolean, default=`False`)\n* `ask_limit_on_launch`: (boolean, default=`False`)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id, default=``)\n* `ask_labels_on_launch`: (boolean, default=`False`)\n* `ask_skip_tags_on_launch`: (boolean, default=`False`)\n* `ask_tags_on_launch`: (boolean, default=`False`)\n* `skip_tags`: (string, default=`\"\"`)\n* `job_tags`: (string, default=`\"\"`)\n\n\n\n\n\n\nFor a PUT request, include **all** fields in the request.\n\n\n\nFor a PATCH request, include only the fields that are being modified.\n\n\n\n# Delete a Workflow Job Template:\n\nMake a DELETE request to this resource to delete this workflow job template.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/access_list/": { + "get": { + "operationId": "api_workflow_job_templates_access_list_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Users:\n\nMake a GET request to this resource to retrieve the list of\nusers.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of users\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more user records. \n\n## Results\n\nEach user data structure includes the following fields:\n\n* `id`: Database ID for this user. (integer)\n* `type`: Data type for this user. (choice)\n* `url`: URL for this user. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this user was created. (datetime)\n* `modified`: Timestamp when this user was last modified. (datetime)\n* `username`: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)\n* `first_name`: (string)\n* `last_name`: (string)\n* `email`: (string)\n* `is_superuser`: Designates that this user has all permissions without explicitly assigning them. (boolean)\n* `is_system_auditor`: (boolean)\n* `password`: Field used to change the password. (string)\n* `ldap_dn`: (string)\n* `last_login`: (datetime)\n* `external_account`: Set if the account is managed by an external service (field)\n\n\n\n## Sorting\n\nTo specify that users are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=username\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-username\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=username,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ResourceAccessListElement" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/activity_stream/": { + "get": { + "operationId": "api_workflow_job_templates_activity_stream_list", + "summary": "# List Activity Streams for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/bitbucket_dc/": { + "post": { + "operationId": "api_workflow_job_templates_bitbucket_dc_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/copy/": { + "get": { + "operationId": "api_workflow_job_templates_copy_list", + "summary": "Copy a Workflow Job Template:", + "description": "Make a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:\n\n* `can_copy`: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)\n* `can_copy_without_user_input`: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)\n* `templates_unable_to_copy`: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `inventories_unable_to_copy`: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `credentials_unable_to_copy`: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n\nMake a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional `@`\nand a timestamp in the name.\n\nAll workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Copy" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_copy_create", + "summary": "Copy a Workflow Job Template:", + "description": "Make a GET request to this resource to determine if the current user has\npermission to copy the workflow job template and whether any linked\ntemplates or prompted fields will be ignored due to permissions problems.\nThe response will include the following fields:\n\n* `can_copy`: Flag indicating whether the active user has permission to make\n a copy of this workflow job template, provides same content as the\n workflow job template detail view summary_fields.user_capabilities.copy\n (boolean, read-only)\n* `can_copy_without_user_input`: Flag indicating if the user should be\n prompted for confirmation before the copy is executed (boolean, read-only)\n* `templates_unable_to_copy`: List of node ids of nodes that have a related\n job template, project, or inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `inventories_unable_to_copy`: List of node ids of nodes that have a related\n prompted inventory that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n* `credentials_unable_to_copy`: List of node ids of nodes that have a related\n prompted credential that the current user lacks permission\n to use and will be missing in workflow nodes of the copy (array, read-only)\n\nMake a POST request to this endpoint to save a copy of this\nworkflow job template. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201. The response body will\ncontain serialized data about the new workflow job template, which will be\nsimilar to the original workflow job template, but with an additional `@`\nand a timestamp in the name.\n\nAll workflow nodes and connections in the original will also exist in the\ncopy. The nodes will be missing related resources if the user did not have\naccess to use them.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Copy" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Copy" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/github/": { + "post": { + "operationId": "api_workflow_job_templates_github_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/gitlab/": { + "post": { + "operationId": "api_workflow_job_templates_gitlab_create", + "description": "", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/labels/": { + "get": { + "operationId": "api_workflow_job_templates_labels_list", + "summary": "# List Labels for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_labels_create", + "summary": "# List Labels for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Label" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Label" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/launch/": { + "get": { + "operationId": "api_workflow_job_templates_launch_read", + "summary": "Launch a Workflow Job Template:", + "description": "Make a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:\n\n* `can_start_without_user_input`: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n workflow_job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)\n* `extra_vars`: Text which is the `extra_vars` field of this workflow_job_template\n (text, read-only)\n* `node_templates_missing`: List of node ids of all nodes that have a\n null `unified_job_template`, which will cause their branches to stop\n execution (list, read-only)\n* `node_prompts_rejected`: List of node ids of all nodes that have\n specified a field that will be rejected because its `unified_job_template`\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)\n* `workflow_job_template_data`: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)\n\nMake a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobLaunch" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_launch_create", + "summary": "Launch a Workflow Job Template:", + "description": "Make a GET request to this resource to determine if the workflow_job_template\ncan be launched and whether any passwords are required to launch the\nworkflow_job_template. The response will include the following fields:\n\n* `can_start_without_user_input`: Flag indicating if the workflow_job_template\n can be launched without user-input (boolean, read-only)\n* `variables_needed_to_start`: Required variable names required to launch the\n workflow_job_template (array, read-only)\n* `survey_enabled`: Flag indicating whether the workflow_job_template has an\n enabled survey (boolean, read-only)\n* `extra_vars`: Text which is the `extra_vars` field of this workflow_job_template\n (text, read-only)\n* `node_templates_missing`: List of node ids of all nodes that have a\n null `unified_job_template`, which will cause their branches to stop\n execution (list, read-only)\n* `node_prompts_rejected`: List of node ids of all nodes that have\n specified a field that will be rejected because its `unified_job_template`\n does not allow prompting for this field, this will not halt execution of\n the branch but the field will be ignored (list, read-only)\n* `workflow_job_template_data`: JSON object listing general information of\n this workflow_job_template (JSON object, read-only)\n\nMake a POST request to this resource to launch the workflow_job_template. If any\ncredential, inventory, project or extra variables (extra_vars) are required, they\nmust be passed via POST data, with extra_vars given as a YAML or JSON string and\nescaped parentheses.\n\nIf successful, the response status code will be 201. If any required passwords\nare not provided, a 400 status code will be returned. If the workflow job cannot\nbe launched, a 405 status code will be returned. If the provided credential or\ninventory are not allowed to be used by the user, then a 403 status code will\nbe returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobLaunch" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobLaunch" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/notification_templates_approvals/": { + "get": { + "operationId": "api_workflow_job_templates_notification_templates_approvals_list", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_notification_templates_approvals_create", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/notification_templates_error/": { + "get": { + "operationId": "api_workflow_job_templates_notification_templates_error_list", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_notification_templates_error_create", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/notification_templates_started/": { + "get": { + "operationId": "api_workflow_job_templates_notification_templates_started_list", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_notification_templates_started_create", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/notification_templates_success/": { + "get": { + "operationId": "api_workflow_job_templates_notification_templates_success_list", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/NotificationTemplate" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_notification_templates_success_create", + "summary": "# List Notification Templates for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nnotification templates associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notification templates\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification template records. \n\n## Results\n\nEach notification template data structure includes the following fields:\n\n* `id`: Database ID for this notification template. (integer)\n* `type`: Data type for this notification template. (choice)\n* `url`: URL for this notification template. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification template was created. (datetime)\n* `modified`: Timestamp when this notification template was last modified. (datetime)\n* `name`: Name of this notification template. (string)\n* `description`: Optional description of this notification template. (string)\n* `organization`: (id)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `notification_configuration`: (json)\n* `messages`: Optional custom messages for notification template. (json)\n\n\n\n## Sorting\n\nTo specify that notification templates are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/NotificationTemplate" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/object_roles/": { + "get": { + "operationId": "api_workflow_job_templates_object_roles_list", + "summary": "> _This resource has been deprecated and will be removed in a future release_", + "description": "# List Roles for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nroles associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of roles\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more role records. \n\n## Results\n\nEach role data structure includes the following fields:\n\n* `id`: Database ID for this role. (integer)\n* `type`: Data type for this role. (choice)\n* `url`: URL for this role. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `name`: Name of this role. (field)\n* `description`: Optional description of this role. (field)\n\n\n\n## Sorting\n\nTo specify that roles are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Role" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/schedules/": { + "get": { + "operationId": "api_workflow_job_templates_schedules_list", + "summary": "# List Schedules for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_schedules_create", + "summary": "# List Schedules for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nschedules associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of schedules\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more schedule records. \n\n## Results\n\nEach schedule data structure includes the following fields:\n\n* `rrule`: A value representing the schedules iCal recurrence rule. (string)\n* `id`: Database ID for this schedule. (integer)\n* `type`: Data type for this schedule. (choice)\n* `url`: URL for this schedule. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this schedule was created. (datetime)\n* `modified`: Timestamp when this schedule was last modified. (datetime)\n* `name`: Name of this schedule. (string)\n* `description`: Optional description of this schedule. (string)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `unified_job_template`: (id)\n* `enabled`: Enables processing of this schedule. (boolean)\n* `dtstart`: The first occurrence of the schedule occurs on or after this time. (datetime)\n* `dtend`: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)\n* `next_run`: The next time that the scheduled action will run. (datetime)\n* `timezone`: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)\n* `until`: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)\n\n\n\n## Sorting\n\nTo specify that schedules are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Schedule" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/survey_spec/": { + "get": { + "operationId": "api_workflow_job_templates_survey_spec_list", + "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_survey_spec_create", + "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_job_templates_survey_spec_delete", + "summary": "POST requests to this resource should include the full specification for a Workflow Job Template's Survey", + "description": "Here is an example survey specification:\n\n {\n \"name\": \"Simple Survey\",\n \"description\": \"Description of the simple survey\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"example question\",\n \t\"question_description\": \"What is your favorite color?\",\n \t\"variable\": \"favorite_color\",\n \t\"required\": false,\n \t\"default\": \"blue\"\n }\n ]\n }\n\n`name` and `description` are required elements at the beginning of the survey specification. `spec` must be a\nlist of survey items.\n\nWithin each survey item `type` must be one of:\n\n* text: For survey questions expecting a textual answer\n* password: For survey questions expecting a password or other sensitive information\n* integer: For survey questions expecting a whole number answer\n* float: For survey questions expecting a decimal number\n* multiplechoice: For survey questions where one option from a list is required\n* multiselect: For survey questions where multiple items from a presented list can be selected\n\nEach item must contain a `question_name` and `question_description` field that describes the survey question itself.\nThe `variable` elements of each survey items represents the key that will be given to the playbook when the workflow job template\nis launched. It will contain the value as a result of the survey.\n\nHere is a more comprehensive example showing the various question types and their acceptable parameters:\n\n {\n \"name\": \"Simple\",\n \"description\": \"Description\",\n \"spec\": [\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbeshort\",\n \t\"question_description\": \"What is a long answer\",\n \t\"variable\": \"long_answer\",\n \t\"choices\": \"\",\n \t\"min\": 5,\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"Leeloo Minai Lekarariba-Laminai-Tchai Ekbat De Sebat\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"cantbelong\",\n \t\"question_description\": \"What is a short answer\",\n \t\"variable\": \"short_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": 7,\n \t\"required\": false,\n \t\"default\": \"leeloo\"\n },\n {\n \t\"type\": \"text\",\n \t\"question_name\": \"reqd\",\n \t\"question_description\": \"I should be required\",\n \t\"variable\": \"reqd_answer\",\n \t\"choices\": \"\",\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": true,\n \t\"default\": \"NOT OPTIONAL\"\n },\n {\n \t\"type\": \"multiplechoice\",\n \t\"question_name\": \"achoice\",\n \t\"question_description\": \"Need one of these\",\n \t\"variable\": \"single_choice\",\n \t\"choices\": [\"one\", \"two\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\"\n },\n {\n \t\"type\": \"multiselect\",\n \t\"question_name\": \"mchoice\",\n \t\"question_description\": \"Can have multiples of these\",\n \t\"variable\": \"multi_choice\",\n \t\"choices\": [\"one\", \"two\", \"three\"],\n \t\"min\": \"\",\n \t\"max\": \"\",\n \t\"required\": false,\n \t\"default\": \"one\\nthree\"\n },\n {\n \"type\": \"integer\",\n \"question_name\": \"integerchoice\",\n \"question_description\": \"I need an int here\",\n \"variable\": \"int_answer\",\n \"choices\": \"\",\n \"min\": 1,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n },\n {\n \"type\": \"float\",\n \"question_name\": \"float\",\n \"question_description\": \"I need a float here\",\n \"variable\": \"float_answer\",\n \"choices\": \"\",\n \"min\": 2,\n \"max\": 5,\n \"required\": false,\n \"default\": \"\"\n }\n ]\n }", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/webhook_key/": { + "get": { + "operationId": "api_workflow_job_templates_webhook_key_list", + "description": "", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_webhook_key_create", + "description": "", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/workflow_jobs/": { + "get": { + "operationId": "api_workflow_job_templates_workflow_jobs_list", + "summary": "# List Workflow Jobs for a Workflow Job Template:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow jobs associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_job_templates/{id}/workflow_nodes/": { + "get": { + "operationId": "api_workflow_job_templates_workflow_nodes_list", + "summary": "# Workflow Job Template Workflow Node List", + "description": "Workflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:\n\n - run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed\n - run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded\n\nThe workflow job is marked as `successful` if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.\n\n\n# List Workflow Job Template Nodes for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_job_templates_workflow_nodes_create", + "summary": "# Workflow Job Template Workflow Node List", + "description": "Workflow nodes reference templates to execute and define the ordering\nin which to execute them. After a job in this workflow finishes,\nthe subsequent actions are to:\n\n - run nodes contained in \"failure_nodes\" or \"always_nodes\" if job failed\n - run nodes contained in \"success_nodes\" or \"always_nodes\" if job succeeded\n\nThe workflow job is marked as `successful` if all of the jobs running as\na part of the workflow job have completed, and the workflow job has not\nbeen canceled. Even if a job within the workflow has failed, the workflow\njob will not be marked as failed.\n\n\n# List Workflow Job Template Nodes for a Workflow Job Template:\n\nMake a GET request to this resource to retrieve a list of\nworkflow job template nodes associated with the selected\nworkflow job template.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job template nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job template node records. \n\n## Results\n\nEach workflow job template node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job template node. (integer)\n* `type`: Data type for this workflow job template node. (choice)\n* `url`: URL for this workflow job template node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job template node was created. (datetime)\n* `modified`: Timestamp when this workflow job template node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `workflow_job_template`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `identifier`: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job template nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobTemplateNode" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/": { + "get": { + "operationId": "api_workflow_jobs_list", + "summary": "# List Workflow Jobs:", + "description": "Make a GET request to this resource to retrieve the list of\nworkflow jobs.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow jobs\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job records. \n\n## Results\n\nEach workflow job data structure includes the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n## Sorting\n\nTo specify that workflow jobs are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/": { + "get": { + "operationId": "api_workflow_jobs_read", + "summary": "# Retrieve a Workflow Job:", + "description": "Make GET request to this resource to retrieve a single workflow job\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Delete a Workflow Job:\n\nMake a DELETE request to this resource to delete this workflow job.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJob" } + } + }, + "tags": ["api"] + }, + "delete": { + "operationId": "api_workflow_jobs_delete", + "summary": "# Retrieve a Workflow Job:", + "description": "Make GET request to this resource to retrieve a single workflow job\nrecord containing the following fields:\n\n* `id`: Database ID for this workflow job. (integer)\n* `type`: Data type for this workflow job. (choice)\n* `url`: URL for this workflow job. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job was created. (datetime)\n* `modified`: Timestamp when this workflow job was last modified. (datetime)\n* `name`: Name of this workflow job. (string)\n* `description`: Optional description of this workflow job. (string)\n* `unified_job_template`: (id)\n* `launch_type`: (choice)\n - `manual`: Manual\n - `relaunch`: Relaunch\n - `callback`: Callback\n - `scheduled`: Scheduled\n - `dependency`: Dependency\n - `workflow`: Workflow\n - `webhook`: Webhook\n - `sync`: Sync\n - `scm`: SCM Update\n* `status`: (choice)\n - `new`: New\n - `pending`: Pending\n - `waiting`: Waiting\n - `running`: Running\n - `successful`: Successful\n - `failed`: Failed\n - `error`: Error\n - `canceled`: Canceled\n* `failed`: (boolean)\n* `started`: The date and time the job was queued for starting. (datetime)\n* `finished`: The date and time the job finished execution. (datetime)\n* `canceled_on`: The date and time when the cancel request was sent. (datetime)\n* `elapsed`: Elapsed time in seconds that the job ran. (decimal)\n* `job_args`: (string)\n* `job_cwd`: (string)\n* `job_env`: (json)\n* `job_explanation`: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)\n* `result_traceback`: (string)\n* `launched_by`: (field)\n* `work_unit_id`: The Receptor work unit ID associated with this job. (string)\n* `workflow_job_template`: (id)\n* `extra_vars`: (json)\n* `allow_simultaneous`: (boolean)\n* `job_template`: If automatically created for a sliced job run, the job template the workflow job was created from. (id)\n* `is_sliced_job`: (boolean)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `limit`: (string)\n* `scm_branch`: (string)\n* `webhook_service`: Service that webhook requests will be accepted from (choice)\n - `\"\"`: ---------\n - `github`: GitHub\n - `gitlab`: GitLab\n - `bitbucket_dc`: BitBucket DataCenter\n* `webhook_credential`: Personal Access Token for posting back the status to the service API (id)\n* `webhook_guid`: Unique identifier of the event that triggered this webhook (string)\n* `skip_tags`: (string)\n* `job_tags`: (string)\n\n\n\n\n\n# Delete a Workflow Job:\n\nMake a DELETE request to this resource to delete this workflow job.", + "parameters": [], + "responses": { "204": { "description": "" } }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/activity_stream/": { + "get": { + "operationId": "api_workflow_jobs_activity_stream_list", + "summary": "# List Activity Streams for a Workflow Job:", + "description": "Make a GET request to this resource to retrieve a list of\nactivity streams associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of activity streams\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more activity stream records. \n\n## Results\n\nEach activity stream data structure includes the following fields:\n\n* `id`: Database ID for this activity stream. (integer)\n* `type`: Data type for this activity stream. (choice)\n* `url`: URL for this activity stream. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `timestamp`: (datetime)\n* `operation`: The action taken with respect to the given object(s). (choice)\n - `create`: Entity Created\n - `update`: Entity Updated\n - `delete`: Entity Deleted\n - `associate`: Entity Associated with another Entity\n - `disassociate`: Entity was Disassociated with another Entity\n* `changes`: A summary of the new and changed values when an object is created, updated, or deleted (json)\n* `object1`: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. (string)\n* `object2`: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. (string)\n* `object_association`: When present, shows the field name of the role or relationship that changed. (field)\n* `action_node`: The cluster node the activity took place on. (string)\n* `object_type`: When present, shows the model on which the role or relationship was defined. (field)\n\n\n\n## Sorting\n\nTo specify that activity streams are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/ActivityStream" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/cancel/": { + "get": { + "operationId": "api_workflow_jobs_cancel_read", + "summary": "# Cancel Workflow Job", + "description": "Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)\n\nMake a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.", + "parameters": [], + "responses": { + "200": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobCancel" } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_jobs_cancel_create", + "summary": "# Cancel Workflow Job", + "description": "Make a GET request to this resource to determine if the workflow job can be\ncanceled. The response will include the following field:\n\n* `can_cancel`: Indicates whether this workflow job is in a state that can\n be canceled (boolean, read-only)\n\nMake a POST request to this endpoint to submit a request to cancel a pending\nor running workflow job. The response status code will be 202 if the\nrequest to cancel was successfully submitted, or 405 if the workflow job\ncannot be canceled.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/WorkflowJobCancel" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/WorkflowJobCancel" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/labels/": { + "get": { + "operationId": "api_workflow_jobs_labels_list", + "summary": "# List Labels for a Workflow Job:", + "description": "Make a GET request to this resource to retrieve a list of\nlabels associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of labels\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more label records. \n\n## Results\n\nEach label data structure includes the following fields:\n\n* `id`: Database ID for this label. (integer)\n* `type`: Data type for this label. (choice)\n* `url`: URL for this label. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this label was created. (datetime)\n* `modified`: Timestamp when this label was last modified. (datetime)\n* `name`: Name of this label. (string)\n* `organization`: Organization this label belongs to. (id)\n\n\n\n## Sorting\n\nTo specify that labels are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Label" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/notifications/": { + "get": { + "operationId": "api_workflow_jobs_notifications_list", + "summary": "# List Notifications for a Workflow Job:", + "description": "Make a GET request to this resource to retrieve a list of\nnotifications associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of notifications\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more notification records. \n\n## Results\n\nEach notification data structure includes the following fields:\n\n* `id`: Database ID for this notification. (integer)\n* `type`: Data type for this notification. (choice)\n* `url`: URL for this notification. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this notification was created. (datetime)\n* `modified`: Timestamp when this notification was last modified. (datetime)\n* `notification_template`: (id)\n* `error`: (string)\n* `status`: (choice)\n - `pending`: Pending\n - `successful`: Successful\n - `failed`: Failed\n* `notifications_sent`: (integer)\n* `notification_type`: (choice)\n - `awssns`: AWS SNS\n - `email`: Email\n - `grafana`: Grafana\n - `irc`: IRC\n - `mattermost`: Mattermost\n - `pagerduty`: Pagerduty\n - `rocketchat`: Rocket.Chat\n - `slack`: Slack\n - `twilio`: Twilio\n - `webhook`: Webhook\n* `recipients`: (string)\n* `subject`: (string)\n* `body`: Notification body (json)\n\n\n\n## Sorting\n\nTo specify that notifications are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Notification" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/relaunch/": { + "get": { + "operationId": "api_workflow_jobs_relaunch_list", + "summary": "Relaunch a workflow job:", + "description": "Make a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/Empty" } + } + } + } + } + }, + "tags": ["api"] + }, + "post": { + "operationId": "api_workflow_jobs_relaunch_create", + "summary": "Relaunch a workflow job:", + "description": "Make a POST request to this endpoint to launch a workflow job identical to the parent workflow job. This will spawn jobs, project updates, or inventory updates based on the unified job templates referenced in the workflow nodes in the workflow job. No POST data is accepted for this action.\n\nIf successful, the response status code will be 201 and serialized data of the new workflow job will be returned.", + "parameters": [ + { + "name": "data", + "in": "body", + "required": true, + "schema": { "$ref": "#/definitions/Empty" } + } + ], + "responses": { + "201": { + "description": "", + "schema": { "$ref": "#/definitions/Empty" } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + }, + "/api/{version}/workflow_jobs/{id}/workflow_nodes/": { + "get": { + "operationId": "api_workflow_jobs_workflow_nodes_list", + "summary": "# List Workflow Job Nodes for a Workflow Job:", + "description": "Make a GET request to this resource to retrieve a list of\nworkflow job nodes associated with the selected\nworkflow job.\n\nThe resulting data structure contains:\n\n {\n \"count\": 99,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n }\n\nThe `count` field indicates the total number of workflow job nodes\nfound for the given query. The `next` and `previous` fields provides links to\nadditional results if there are more than will fit on a single page. The\n`results` list contains zero or more workflow job node records. \n\n## Results\n\nEach workflow job node data structure includes the following fields:\n\n* `id`: Database ID for this workflow job node. (integer)\n* `type`: Data type for this workflow job node. (choice)\n* `url`: URL for this workflow job node. (string)\n* `related`: Data structure with URLs of related resources. (object)\n* `summary_fields`: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)\n* `created`: Timestamp when this workflow job node was created. (datetime)\n* `modified`: Timestamp when this workflow job node was last modified. (datetime)\n* `extra_data`: (json)\n* `inventory`: Inventory applied as a prompt, assuming job template prompts for inventory (id)\n* `scm_branch`: (string)\n* `job_type`: (choice)\n - `None`: ---------\n - `\"\"`: ---------\n - `run`: Run\n - `check`: Check\n* `job_tags`: (string)\n* `skip_tags`: (string)\n* `limit`: (string)\n* `diff_mode`: (boolean)\n* `verbosity`: (choice)\n - `None`: ---------\n - `0`: 0 (Normal)\n - `1`: 1 (Verbose)\n - `2`: 2 (More Verbose)\n - `3`: 3 (Debug)\n - `4`: 4 (Connection Debug)\n - `5`: 5 (WinRM Debug)\n* `execution_environment`: The container image to be used for execution. (id)\n* `forks`: (integer)\n* `job_slice_count`: (integer)\n* `timeout`: (integer)\n* `job`: (id)\n* `workflow_job`: (id)\n* `unified_job_template`: (id)\n* `success_nodes`: (field)\n* `failure_nodes`: (field)\n* `always_nodes`: (field)\n* `all_parents_must_converge`: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean)\n* `do_not_run`: Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. (boolean)\n* `identifier`: An identifier coresponding to the workflow job template node that this node was created from. (string)\n\n\n\n## Sorting\n\nTo specify that workflow job nodes are returned in a particular\norder, use the `order_by` query string parameter on the GET request.\n\n ?order_by=name\n\nPrefix the field name with a dash `-` to sort in reverse:\n\n ?order_by=-name\n\nMultiple sorting fields may be specified by separating the field names with a\ncomma `,`:\n\n ?order_by=name,some_other_field\n\n## Pagination\n\nUse the `page_size` query string parameter to change the number of results\nreturned for each request. Use the `page` query string parameter to retrieve\na particular page of results.\n\n ?page_size=100&page=2\n\nThe `previous` and `next` links returned with the results will set these query\nstring parameters automatically.\n\n## Searching\n\nUse the `search` query string parameter to perform a case-insensitive search\nwithin all designated text fields of a model.\n\n ?search=findme\n\n(_Added in Ansible Tower 3.1.0_) Search across related fields:\n\n ?related__search=findme", + "parameters": [ + { + "name": "search", + "in": "query", + "description": "A search term.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "description": "A page number within the paginated result set.", + "required": false, + "type": "integer" + }, + { + "name": "page_size", + "in": "query", + "description": "Number of results to return per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "required": ["count", "results"], + "type": "object", + "properties": { + "count": { "type": "integer" }, + "next": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "previous": { + "type": "string", + "format": "uri", + "x-nullable": true + }, + "results": { + "type": "array", + "items": { "$ref": "#/definitions/WorkflowJobNodeList" } + } + } + } + } + }, + "tags": ["api"] + }, + "parameters": [ + { "name": "version", "in": "path", "required": true, "type": "string" }, + { "name": "id", "in": "path", "required": true, "type": "string" } + ] + } + }, + "definitions": { + "RoleDefinition": { + "required": ["permissions", "name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "permissions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "awx.add_credential", + "awx.add_executionenvironment", + "awx.add_inventory", + "awx.add_notificationtemplate", + "awx.add_project", + "awx.add_workflowjobtemplate", + "awx.adhoc_inventory", + "awx.approve_workflowjobtemplate", + "awx.change_credential", + "awx.change_executionenvironment", + "awx.change_instancegroup", + "awx.change_inventory", + "awx.change_jobtemplate", + "awx.change_notificationtemplate", + "awx.change_project", + "awx.change_workflowjobtemplate", + "awx.delete_credential", + "awx.delete_executionenvironment", + "awx.delete_instancegroup", + "awx.delete_inventory", + "awx.delete_jobtemplate", + "awx.delete_notificationtemplate", + "awx.delete_project", + "awx.delete_workflowjobtemplate", + "awx.execute_jobtemplate", + "awx.execute_workflowjobtemplate", + "awx.update_inventory", + "awx.update_project", + "awx.use_credential", + "awx.use_instancegroup", + "awx.use_inventory", + "awx.use_project", + "awx.view_credential", + "awx.view_instancegroup", + "awx.view_inventory", + "awx.view_jobtemplate", + "awx.view_notificationtemplate", + "awx.view_project", + "awx.view_workflowjobtemplate", + "shared.add_team", + "shared.audit_organization", + "shared.change_organization", + "shared.change_team", + "shared.delete_organization", + "shared.delete_team", + "shared.member_organization", + "shared.member_team", + "shared.view_organization", + "shared.view_team" + ] + } + }, + "content_type": { + "title": "Content type", + "description": "The type of resource this applies to", + "type": "string", + "enum": [ + "awx.credential", + "awx.executionenvironment", + "awx.instancegroup", + "awx.inventory", + "awx.jobtemplate", + "awx.notificationtemplate", + "awx.project", + "awx.workflowjobtemplate", + "shared.organization", + "shared.team" + ], + "x-nullable": true + }, + "modified": { + "title": "Modified", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "created": { + "title": "Created", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "name": { "title": "Name", "type": "string", "minLength": 1 }, + "description": { "title": "Description", "type": "string" }, + "managed": { "title": "Managed", "type": "boolean", "readOnly": true }, + "modified_by": { + "title": "Modified by", + "description": "The user who last modified this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "created_by": { + "title": "Created by", + "description": "The user who created this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + } + } + }, + "RoleDefinitionDetail": { + "required": ["permissions", "name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "permissions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "awx.add_credential", + "awx.add_executionenvironment", + "awx.add_inventory", + "awx.add_notificationtemplate", + "awx.add_project", + "awx.add_workflowjobtemplate", + "awx.adhoc_inventory", + "awx.approve_workflowjobtemplate", + "awx.change_credential", + "awx.change_executionenvironment", + "awx.change_instancegroup", + "awx.change_inventory", + "awx.change_jobtemplate", + "awx.change_notificationtemplate", + "awx.change_project", + "awx.change_workflowjobtemplate", + "awx.delete_credential", + "awx.delete_executionenvironment", + "awx.delete_instancegroup", + "awx.delete_inventory", + "awx.delete_jobtemplate", + "awx.delete_notificationtemplate", + "awx.delete_project", + "awx.delete_workflowjobtemplate", + "awx.execute_jobtemplate", + "awx.execute_workflowjobtemplate", + "awx.update_inventory", + "awx.update_project", + "awx.use_credential", + "awx.use_instancegroup", + "awx.use_inventory", + "awx.use_project", + "awx.view_credential", + "awx.view_instancegroup", + "awx.view_inventory", + "awx.view_jobtemplate", + "awx.view_notificationtemplate", + "awx.view_project", + "awx.view_workflowjobtemplate", + "shared.add_team", + "shared.audit_organization", + "shared.change_organization", + "shared.change_team", + "shared.delete_organization", + "shared.delete_team", + "shared.member_organization", + "shared.member_team", + "shared.view_organization", + "shared.view_team" + ] + } + }, + "content_type": { + "title": "Content type", + "description": "The type of resource this applies to", + "type": "string", + "enum": [ + "awx.credential", + "awx.executionenvironment", + "awx.instancegroup", + "awx.inventory", + "awx.jobtemplate", + "awx.notificationtemplate", + "awx.project", + "awx.workflowjobtemplate", + "shared.organization", + "shared.team" + ], + "readOnly": true + }, + "modified": { + "title": "Modified", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "created": { + "title": "Created", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "name": { "title": "Name", "type": "string", "minLength": 1 }, + "description": { "title": "Description", "type": "string" }, + "managed": { "title": "Managed", "type": "boolean", "readOnly": true }, + "modified_by": { + "title": "Modified by", + "description": "The user who last modified this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "created_by": { + "title": "Created by", + "description": "The user who created this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + } + } + }, + "RoleTeamAssignment": { + "required": ["role_definition"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { + "title": "Created", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "created_by": { + "title": "Created by", + "description": "The user who created this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "content_type": { + "title": "Content type", + "description": "The type of resource this applies to", + "type": "string", + "enum": [ + "awx.credential", + "awx.executionenvironment", + "awx.instancegroup", + "awx.inventory", + "awx.jobtemplate", + "awx.notificationtemplate", + "awx.project", + "awx.workflowjobtemplate", + "shared.organization", + "shared.team" + ], + "readOnly": true + }, + "object_id": { + "title": "Object id", + "description": "Primary key of the object this assignment applies to, null value indicates system-wide assignment", + "type": "string", + "x-nullable": true + }, + "object_ansible_id": { + "title": "Object ansible id", + "description": "Resource id of the object this role applies to. Alternative to the object_id field.", + "type": "string", + "format": "uuid", + "x-nullable": true + }, + "role_definition": { + "title": "Role definition", + "description": "The role definition which defines permissions conveyed by this assignment", + "type": "integer" + }, + "team": { "title": "Team", "type": "integer" }, + "team_ansible_id": { + "title": "Team ansible id", + "description": "Resource id of the team who will receive permissions from this assignment. Alternative to team field.", + "type": "string", + "format": "uuid" + } + } + }, + "RoleUserAssignment": { + "required": ["role_definition"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { + "title": "Created", + "description": "The date/time this resource was created", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "created_by": { + "title": "Created by", + "description": "The user who created this resource", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "content_type": { + "title": "Content type", + "description": "The type of resource this applies to", + "type": "string", + "enum": [ + "awx.credential", + "awx.executionenvironment", + "awx.instancegroup", + "awx.inventory", + "awx.jobtemplate", + "awx.notificationtemplate", + "awx.project", + "awx.workflowjobtemplate", + "shared.organization", + "shared.team" + ], + "readOnly": true + }, + "object_id": { + "title": "Object id", + "description": "Primary key of the object this assignment applies to, null value indicates system-wide assignment", + "type": "string", + "x-nullable": true + }, + "object_ansible_id": { + "title": "Object ansible id", + "description": "Resource id of the object this role applies to. Alternative to the object_id field.", + "type": "string", + "format": "uuid", + "x-nullable": true + }, + "role_definition": { + "title": "Role definition", + "description": "The role definition which defines permissions conveyed by this assignment", + "type": "integer" + }, + "user": { "title": "User", "type": "integer" }, + "user_ansible_id": { + "title": "User ansible id", + "description": "Resource id of the user who will receive permissions from this assignment. Alternative to user field.", + "type": "string", + "format": "uuid", + "x-nullable": true + } + } + }, + "RoleMetadata": { + "required": ["allowed_permissions"], + "type": "object", + "properties": { + "allowed_permissions": { + "title": "Allowed permissions", + "description": "List of permissions allowed for a role definition, given its content type.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true } + } + } + }, + "ResourceType": { + "required": ["externally_managed"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "externally_managed": { + "title": "Externally managed", + "type": "boolean" + }, + "shared_resource_type": { + "title": "Shared resource type", + "type": "string", + "readOnly": true + }, + "url": { "title": "Url", "type": "string", "readOnly": true } + } + }, + "ResourceList": { + "required": ["resource_data"], + "type": "object", + "properties": { + "object_id": { + "title": "Object id", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "ansible_id": { + "title": "Ansible id", + "type": "string", + "format": "uuid" + }, + "service_id": { + "title": "Service id", + "description": "ID of the service responsible for managing this resource.", + "type": "string", + "format": "uuid" + }, + "is_partially_migrated": { + "title": "Is partially migrated", + "description": "This gets set to True when a resource has been copied into the resource server, but the service_id hasn't been updated yet.", + "type": "boolean" + }, + "resource_type": { + "title": "Resource type", + "type": "string", + "minLength": 1 + }, + "has_serializer": { + "title": "Has serializer", + "type": "boolean", + "readOnly": true + }, + "resource_data": { "title": "Resource data", "type": "object" }, + "url": { "title": "Url", "type": "string", "readOnly": true } + } + }, + "Resource": { + "required": ["resource_data"], + "type": "object", + "properties": { + "object_id": { + "title": "Object id", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "ansible_id": { + "title": "Ansible id", + "type": "string", + "format": "uuid" + }, + "service_id": { + "title": "Service id", + "description": "ID of the service responsible for managing this resource.", + "type": "string", + "format": "uuid" + }, + "is_partially_migrated": { + "title": "Is partially migrated", + "description": "This gets set to True when a resource has been copied into the resource server, but the service_id hasn't been updated yet.", + "type": "boolean" + }, + "resource_type": { + "title": "Resource type", + "type": "string", + "minLength": 1 + }, + "has_serializer": { + "title": "Has serializer", + "type": "boolean", + "readOnly": true + }, + "resource_data": { "title": "Resource data", "type": "object" }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "additional_data": { + "title": "Additional data", + "type": "string", + "readOnly": true + } + } + }, + "ActivityStream": { + "required": ["operation", "object1", "object2"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "operation": { + "title": "Operation", + "description": "The action taken with respect to the given object(s).", + "type": "string", + "enum": ["create", "update", "delete", "associate", "disassociate"], + "x-nullable": true + }, + "changes": { + "title": "Changes", + "description": "A summary of the new and changed values when an object is created, updated, or deleted", + "type": "string", + "readOnly": true + }, + "object1": { + "title": "Object1", + "description": "For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.", + "type": "string", + "minLength": 1, + "x-nullable": true + }, + "object2": { + "title": "Object2", + "description": "Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.", + "type": "string", + "minLength": 1, + "x-nullable": true + }, + "object_association": { + "title": "Object association", + "description": "When present, shows the field name of the role or relationship that changed.", + "type": "string", + "readOnly": true + }, + "action_node": { + "title": "Action node", + "description": "The cluster node the activity took place on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "object_type": { + "title": "Object type", + "description": "When present, shows the model on which the role or relationship was defined.", + "type": "string", + "readOnly": true + } + } + }, + "AdHocCommandEvent": { + "required": ["event"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "ad_hoc_command": { + "title": "Ad hoc command", + "type": "string", + "readOnly": true + }, + "event": { + "title": "Event", + "type": "string", + "enum": [ + "runner_on_failed", + "runner_on_ok", + "runner_on_unreachable", + "runner_on_skipped", + "debug", + "verbose", + "deprecated", + "warning", + "system_warning", + "error" + ], + "x-nullable": true + }, + "counter": { + "title": "Counter", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "event_display": { + "title": "Event display", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_data": { + "title": "Event data", + "type": "object", + "default": {} + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "changed": { "title": "Changed", "type": "boolean", "readOnly": true }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "host": { + "title": "Host", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "host_name": { + "title": "Host name", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "stdout": { + "title": "Stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "start_line": { + "title": "Start line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "end_line": { + "title": "End line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "readOnly": true, + "minimum": 0 + } + } + }, + "AdHocCommandList": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "default": "run", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "limit": { + "title": "Limit", + "type": "string", + "default": "", + "x-nullable": true + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "module_name": { + "title": "Module name", + "type": "string", + "enum": [ + "command", + "shell", + "yum", + "apt", + "apt_key", + "apt_repository", + "apt_rpm", + "service", + "group", + "user", + "mount", + "ping", + "selinux", + "setup", + "win_ping", + "win_service", + "win_updates", + "win_group", + "win_user" + ], + "default": "command" + }, + "module_args": { + "title": "Module args", + "type": "string", + "default": "", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5], + "default": 0 + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "become_enabled": { + "title": "Become enabled", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "default": false, + "x-nullable": true + } + } + }, + "AdHocCommandDetail": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "Job env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "default": "run", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "limit": { + "title": "Limit", + "type": "string", + "default": "", + "x-nullable": true + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "module_name": { + "title": "Module name", + "type": "string", + "enum": [ + "command", + "shell", + "yum", + "apt", + "apt_key", + "apt_repository", + "apt_rpm", + "service", + "group", + "user", + "mount", + "ping", + "selinux", + "setup", + "win_ping", + "win_service", + "win_updates", + "win_group", + "win_user" + ], + "default": "command" + }, + "module_args": { + "title": "Module args", + "type": "string", + "default": "", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5], + "default": 0 + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "become_enabled": { + "title": "Become enabled", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "host_status_counts": { + "title": "Host status counts", + "description": "Playbook stats from the Ansible playbook_on_stats event.", + "type": "object", + "readOnly": true, + "x-nullable": true + } + } + }, + "AdHocCommandCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + }, + "Notification": { + "required": ["notification_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "notification_template": { + "title": "Notification template", + "type": "integer", + "readOnly": true + }, + "error": { + "title": "Error", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "status": { + "title": "Status", + "type": "string", + "enum": ["pending", "successful", "failed"], + "readOnly": true + }, + "notifications_sent": { + "title": "Notifications sent", + "type": "integer", + "readOnly": true + }, + "notification_type": { + "title": "Notification type", + "type": "string", + "enum": [ + "awssns", + "email", + "grafana", + "irc", + "mattermost", + "pagerduty", + "rocketchat", + "slack", + "twilio", + "webhook" + ], + "x-nullable": true + }, + "recipients": { + "title": "Recipients", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "subject": { + "title": "Subject", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "body": { + "title": "Body", + "description": "Notification body", + "type": "string", + "readOnly": true + } + } + }, + "AdHocCommandRelaunch": { "type": "object", "properties": {} }, + "UnifiedJobStdout": { + "type": "object", + "properties": { + "result_stdout": { + "title": "Result stdout", + "type": "string", + "readOnly": true + } + } + }, + "OAuth2Application": { + "required": [ + "name", + "client_type", + "authorization_grant_type", + "organization" + ], + "type": "object", + "properties": { + "id": { "title": "Id", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 255, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "client_id": { + "title": "Client id", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "client_secret": { + "title": "Client Secret", + "description": "Used for more stringent verification of access to an application when creating a token.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "client_type": { + "title": "Client Type", + "description": "Set to Public or Confidential depending on how secure the client device is.", + "type": "string", + "enum": ["confidential", "public"], + "x-nullable": true + }, + "redirect_uris": { + "title": "Redirect URIs", + "description": "Allowed URIs list, space separated", + "type": "string", + "x-nullable": true + }, + "authorization_grant_type": { + "title": "Authorization Grant Type", + "description": "The Grant type the user must use for acquire tokens for this application.", + "type": "string", + "enum": ["authorization-code", "password"], + "x-nullable": true + }, + "skip_authorization": { + "title": "Skip Authorization", + "description": "Set True to skip authorization step for completely trusted applications.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Organization containing this application.", + "type": "integer" + } + } + }, + "OAuth2Token": { + "type": "object", + "properties": { + "id": { "title": "Id", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "user": { + "title": "User", + "description": "The user representing the token owner", + "type": "integer", + "readOnly": true + }, + "token": { "title": "Token", "type": "string", "readOnly": true }, + "refresh_token": { + "title": "Refresh token", + "type": "string", + "readOnly": true + }, + "application": { + "title": "Application", + "type": "integer", + "x-nullable": true + }, + "expires": { + "title": "Expires", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "title": "Scope", + "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", + "type": "string", + "default": "write", + "x-nullable": true + } + } + }, + "BulkHost": { + "required": ["name"], + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "enabled": { + "title": "Enabled", + "description": "Is this host online and available for running jobs?", + "type": "boolean", + "default": true, + "x-nullable": true + }, + "instance_id": { + "title": "Instance id", + "description": "The value used by the remote inventory source to uniquely identify the host", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "variables": { + "title": "Variables", + "description": "Host variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "BulkHostCreate": { + "required": ["inventory", "hosts"], + "type": "object", + "properties": { + "inventory": { + "title": "Inventory", + "description": "Primary Key ID of inventory to add hosts to.", + "type": "integer" + }, + "hosts": { + "description": "List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]", + "type": "array", + "items": { "$ref": "#/definitions/BulkHost" }, + "maxItems": 100000 + } + } + }, + "BulkHostDelete": { + "required": ["hosts"], + "type": "object", + "properties": { + "hosts": { + "description": "List of hosts ids to be deleted, e.g. [105, 130, 131, 200]", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "maxItems": 100000 + } + } + }, + "BulkJobNode": { + "description": "List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", + "required": ["unified_job_template"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { "title": "Inventory", "type": "integer", "minimum": 1 }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "type": "integer", + "minimum": 1 + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "job": { "title": "Job", "type": "integer", "x-nullable": true }, + "workflow_job": { + "title": "Workflow job", + "type": "string", + "x-nullable": true + }, + "unified_job_template": { + "title": "Unified job template", + "description": "Primary key of the template for this job, can be a job template or inventory source.", + "type": "integer", + "minimum": 1 + }, + "success_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "failure_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "always_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "all_parents_must_converge": { + "title": "All parents must converge", + "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "do_not_run": { + "title": "Do not run", + "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "identifier": { + "title": "Identifier", + "description": "An identifier coresponding to the workflow job template node that this node was created from.", + "type": "string", + "maxLength": 512, + "x-nullable": true + }, + "credentials": { + "type": "array", + "items": { "type": "integer", "minimum": 1 } + }, + "labels": { + "type": "array", + "items": { "type": "integer", "minimum": 1 } + }, + "instance_groups": { + "type": "array", + "items": { "type": "integer", "minimum": 1 } + } + } + }, + "BulkJobLaunch": { + "required": ["jobs"], + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string", + "default": "Bulk Job Launch", + "maxLength": 512 + }, + "jobs": { + "description": "List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]", + "type": "array", + "items": { "$ref": "#/definitions/BulkJobNode" } + }, + "description": { + "title": "Description", + "type": "string", + "minLength": 1 + }, + "extra_vars": { "title": "Extra vars", "type": "object" }, + "organization": { + "title": "Organization", + "description": "Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically.", + "type": "integer", + "x-nullable": true + }, + "inventory": { "title": "Inventory", "type": "integer" }, + "limit": { "title": "Limit", "type": "string", "minLength": 1 }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "minLength": 1 + }, + "skip_tags": { "title": "Skip tags", "type": "string", "minLength": 1 }, + "job_tags": { "title": "Job tags", "type": "string", "minLength": 1 } + } + }, + "ConstructedInventory": { + "required": ["name", "organization"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Organization containing this inventory.", + "type": "integer", + "x-nullable": true + }, + "kind": { + "title": "Kind", + "description": "Kind of inventory being represented.", + "type": "string", + "enum": ["", "smart", "constructed"], + "readOnly": true, + "x-nullable": true + }, + "variables": { + "title": "Variables", + "description": "Inventory variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "has_active_failures": { + "title": "Has active failures", + "description": "This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", + "type": "boolean", + "readOnly": true + }, + "total_hosts": { + "title": "Total hosts", + "description": "This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "hosts_with_active_failures": { + "title": "Hosts with active failures", + "description": "This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "total_groups": { + "title": "Total groups", + "description": "This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "has_inventory_sources": { + "title": "Has inventory sources", + "description": "This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", + "type": "boolean", + "readOnly": true + }, + "total_inventory_sources": { + "title": "Total inventory sources", + "description": "Total number of external inventory sources configured within this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "inventory_sources_with_failures": { + "title": "Inventory sources with failures", + "description": "Number of external inventory sources in this inventory with failures.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "pending_deletion": { + "title": "Pending deletion", + "description": "Flag indicating the inventory is being deleted.", + "type": "boolean", + "readOnly": true + }, + "prevent_instance_group_fallback": { + "title": "Prevent instance group fallback", + "description": "If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "source_vars": { + "title": "Source vars", + "description": "The source_vars for the related auto-created inventory source, special to constructed inventory.", + "type": "string" + }, + "update_cache_timeout": { + "title": "Update cache timeout", + "description": "The cache timeout for the related auto-created inventory source, special to constructed inventory", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "limit": { + "title": "Limit", + "description": "The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.", + "type": "string" + }, + "verbosity": { + "title": "Verbosity", + "description": "The verbosity level for the related auto-created inventory source, special to constructed inventory", + "type": "integer", + "maximum": 2, + "minimum": 0, + "x-nullable": true + } + } + }, + "CredentialInputSource": { + "required": [ + "input_field_name", + "target_credential", + "source_credential" + ], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "input_field_name": { + "title": "Input field name", + "type": "string", + "maxLength": 1024, + "minLength": 1, + "x-nullable": true + }, + "metadata": { "title": "Metadata", "type": "object", "default": {} }, + "target_credential": { + "title": "Target credential", + "type": "integer", + "x-nullable": true + }, + "source_credential": { + "title": "Source credential", + "type": "integer", + "x-nullable": true + } + } + }, + "CredentialType": { + "required": ["name", "kind"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "kind": { + "title": "Kind", + "type": "string", + "enum": [ + "ssh", + "vault", + "net", + "scm", + "cloud", + "registry", + "token", + "insights", + "external", + "kubernetes", + "galaxy", + "cryptography" + ], + "x-nullable": true + }, + "namespace": { + "title": "Namespace", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "injectors": { + "title": "Injectors", + "description": "Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + } + } + }, + "Credential": { + "required": ["name", "credential_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "type": "integer", + "x-nullable": true + }, + "credential_type": { + "title": "Credential Type", + "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", + "type": "integer" + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "kind": { "title": "Kind", "type": "string", "readOnly": true }, + "cloud": { "title": "Cloud", "type": "string", "readOnly": true }, + "kubernetes": { + "title": "Kubernetes", + "type": "string", + "readOnly": true + } + } + }, + "Empty": { "type": "object", "properties": {} }, + "CredentialSerializerCreate": { + "required": ["name", "credential_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team.", + "type": "integer", + "x-nullable": true + }, + "credential_type": { + "title": "Credential Type", + "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", + "type": "integer" + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "kind": { "title": "Kind", "type": "string", "readOnly": true }, + "cloud": { "title": "Cloud", "type": "string", "readOnly": true }, + "kubernetes": { + "title": "Kubernetes", + "type": "string", + "readOnly": true + }, + "user": { + "title": "User", + "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", + "type": "integer", + "x-nullable": true + }, + "team": { + "title": "Team", + "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", + "type": "integer", + "x-nullable": true + } + } + }, + "ResourceAccessListElement": { + "required": ["username"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "username": { + "title": "Username", + "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", + "type": "string", + "pattern": "^[\\w.@+-]+$", + "maxLength": 150, + "minLength": 1, + "x-nullable": true + }, + "first_name": { + "title": "First name", + "type": "string", + "maxLength": 150, + "x-nullable": true + }, + "last_name": { + "title": "Last name", + "type": "string", + "maxLength": 150, + "x-nullable": true + }, + "email": { + "title": "Email address", + "type": "string", + "maxLength": 254, + "x-nullable": true + }, + "is_superuser": { + "title": "Superuser status", + "description": "Designates that this user has all permissions without explicitly assigning them.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "is_system_auditor": { + "title": "Is system auditor", + "type": "boolean", + "default": false + }, + "password": { + "title": "Password", + "description": "Field used to change the password.", + "type": "string", + "default": "", + "minLength": 1 + }, + "ldap_dn": { + "title": "Ldap dn", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "last_login": { + "title": "Last login", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "external_account": { + "title": "External account", + "description": "Set if the account is managed by an external service", + "type": "string", + "readOnly": true + } + } + }, + "Copy": { + "required": ["name"], + "type": "object", + "properties": { + "name": { "title": "Name", "type": "string", "minLength": 1 } + } + }, + "Role": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "name": { "title": "Name", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "readOnly": true + } + } + }, + "Team": { + "required": ["name", "organization"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { "title": "Organization", "type": "integer" } + } + }, + "User": { + "required": ["username"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "username": { + "title": "Username", + "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", + "type": "string", + "pattern": "^[\\w.@+-]+$", + "maxLength": 150, + "minLength": 1, + "x-nullable": true + }, + "first_name": { + "title": "First name", + "type": "string", + "maxLength": 150, + "x-nullable": true + }, + "last_name": { + "title": "Last name", + "type": "string", + "maxLength": 150, + "x-nullable": true + }, + "email": { + "title": "Email address", + "type": "string", + "maxLength": 254, + "x-nullable": true + }, + "is_superuser": { + "title": "Superuser status", + "description": "Designates that this user has all permissions without explicitly assigning them.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "is_system_auditor": { + "title": "Is system auditor", + "type": "boolean", + "default": false + }, + "password": { + "title": "Password", + "description": "Field used to change the password.", + "type": "string", + "default": "", + "minLength": 1 + }, + "ldap_dn": { + "title": "Ldap dn", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "last_login": { + "title": "Last login", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "external_account": { + "title": "External account", + "description": "Set if the account is managed by an external service", + "type": "string", + "readOnly": true + } + } + }, + "ExecutionEnvironment": { + "required": ["name", "image"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this execution environment.", + "type": "integer", + "x-nullable": true + }, + "image": { + "title": "Image location", + "description": "The full image location, including the container registry, image name, and version tag.", + "type": "string", + "maxLength": 1024, + "minLength": 1, + "x-nullable": true + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "pull": { + "title": "Pull", + "description": "Pull image before running?", + "type": "string", + "enum": ["always", "missing", "never"], + "default": "", + "x-nullable": true + } + } + }, + "UnifiedJobTemplate": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "ok", + "missing", + "none", + "updating" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + } + } + }, + "Group": { + "required": ["name", "inventory"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "inventory": { "title": "Inventory", "type": "integer" }, + "variables": { + "title": "Variables", + "description": "Group variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "Host": { + "required": ["name", "inventory"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "inventory": { "title": "Inventory", "type": "integer" }, + "enabled": { + "title": "Enabled", + "description": "Is this host online and available for running jobs?", + "type": "boolean", + "default": true, + "x-nullable": true + }, + "instance_id": { + "title": "Instance id", + "description": "The value used by the remote inventory source to uniquely identify the host", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "variables": { + "title": "Variables", + "description": "Host variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "has_active_failures": { + "title": "Has active failures", + "type": "string", + "readOnly": true + }, + "has_inventory_sources": { + "title": "Has inventory sources", + "type": "string", + "readOnly": true + }, + "last_job": { + "title": "Last job", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "last_job_host_summary": { + "title": "Last job host summary", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "ansible_facts_modified": { + "title": "Ansible facts modified", + "description": "The date and time ansible_facts was last modified.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + } + } + }, + "InventorySource": { + "required": ["name", "inventory"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "source": { + "title": "Source", + "type": "string", + "enum": [ + "file", + "constructed", + "scm", + "ec2", + "gce", + "azure_rm", + "vmware", + "satellite6", + "openstack", + "rhv", + "controller", + "insights", + "terraform", + "openshift_virtualization" + ], + "x-nullable": true + }, + "source_path": { + "title": "Source path", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "source_vars": { + "title": "Source vars", + "description": "Inventory source variables in YAML or JSON format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "description": "Cloud credential to use for inventory updates.", + "type": "integer", + "minimum": 1, + "x-nullable": true + }, + "enabled_var": { + "title": "Enabled var", + "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", + "type": "string", + "default": "", + "x-nullable": true + }, + "enabled_value": { + "title": "Enabled value", + "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", + "type": "string", + "default": "", + "x-nullable": true + }, + "host_filter": { + "title": "Host filter", + "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", + "type": "string", + "default": "", + "x-nullable": true + }, + "overwrite": { + "title": "Overwrite", + "description": "Overwrite local groups and hosts from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "overwrite_vars": { + "title": "Overwrite vars", + "description": "Overwrite local variables from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "description": "Local absolute file path containing a custom Python virtualenv to use", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2], + "default": 1 + }, + "limit": { + "title": "Limit", + "description": "Enter host, group or pattern match", + "type": "string", + "default": "", + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "none" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "update_on_launch": { + "title": "Update on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "update_cache_timeout": { + "title": "Update cache timeout", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "source_project": { + "title": "Source project", + "description": "Project containing inventory file used as source.", + "type": "string", + "x-nullable": true + }, + "last_update_failed": { + "title": "Last update failed", + "type": "boolean", + "readOnly": true + }, + "last_updated": { + "title": "Last updated", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "JobEvent": { + "required": ["event"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "job": { + "title": "Job", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "event": { + "title": "Event", + "type": "string", + "enum": [ + "runner_on_failed", + "runner_on_start", + "runner_on_ok", + "runner_on_error", + "runner_on_skipped", + "runner_on_unreachable", + "runner_on_no_hosts", + "runner_on_async_poll", + "runner_on_async_ok", + "runner_on_async_failed", + "runner_item_on_ok", + "runner_item_on_failed", + "runner_item_on_skipped", + "runner_retry", + "runner_on_file_diff", + "playbook_on_start", + "playbook_on_notify", + "playbook_on_include", + "playbook_on_no_hosts_matched", + "playbook_on_no_hosts_remaining", + "playbook_on_task_start", + "playbook_on_vars_prompt", + "playbook_on_setup", + "playbook_on_import_for_host", + "playbook_on_not_import_for_host", + "playbook_on_play_start", + "playbook_on_stats", + "debug", + "verbose", + "deprecated", + "warning", + "system_warning", + "error" + ], + "x-nullable": true + }, + "counter": { + "title": "Counter", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "event_display": { + "title": "Event display", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_data": { + "title": "Event data", + "type": "object", + "default": {} + }, + "event_level": { + "title": "Event level", + "type": "integer", + "readOnly": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "changed": { "title": "Changed", "type": "boolean", "readOnly": true }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "parent_uuid": { + "title": "Parent uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "host": { + "title": "Host", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "host_name": { + "title": "Host name", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "playbook": { + "title": "Playbook", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "play": { + "title": "Play", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "task": { + "title": "Task", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "role": { + "title": "Role", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "stdout": { + "title": "Stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "start_line": { + "title": "Start line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "end_line": { + "title": "End line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "readOnly": true, + "minimum": 0 + } + } + }, + "JobHostSummary": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "job": { "title": "Job", "type": "string", "readOnly": true }, + "host": { + "title": "Host", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "constructed_host": { + "title": "Constructed host", + "description": "Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "host_name": { + "title": "Host name", + "type": "string", + "readOnly": true, + "default": "", + "minLength": 1 + }, + "changed": { + "title": "Changed", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "dark": { + "title": "Dark", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "failures": { + "title": "Failures", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "ok": { + "title": "Ok", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "processed": { + "title": "Processed", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "skipped": { + "title": "Skipped", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "ignored": { + "title": "Ignored", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "rescued": { + "title": "Rescued", + "type": "integer", + "readOnly": true, + "minimum": 0 + } + } + }, + "GroupVariableData": { + "type": "object", + "properties": { + "variables": { + "title": "Variables", + "description": "Group variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "HostMetricSummaryMonthly": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "date": { + "title": "Date", + "type": "string", + "format": "date", + "readOnly": true + }, + "license_consumed": { + "title": "License consumed", + "description": "How many unique hosts are consumed from the license", + "type": "integer", + "readOnly": true + }, + "license_capacity": { + "title": "License capacity", + "description": "'License capacity as max. number of unique hosts", + "type": "integer", + "readOnly": true + }, + "hosts_added": { + "title": "Hosts added", + "description": "How many hosts were added in the associated month, consuming more license capacity", + "type": "integer", + "readOnly": true + }, + "hosts_deleted": { + "title": "Hosts deleted", + "description": "How many hosts were deleted in the associated month, freeing the license capacity", + "type": "integer", + "readOnly": true + }, + "indirectly_managed_hosts": { + "title": "Indirectly managed hosts", + "description": "Manually entered number indirectly managed hosts for a certain month", + "type": "integer", + "readOnly": true + } + } + }, + "HostMetric": { + "required": ["hostname", "last_automation"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "hostname": { + "title": "Hostname", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "first_automation": { + "title": "First automation", + "description": "When the host was first automated against", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "last_automation": { + "title": "Last automation", + "description": "When the host was last automated against", + "type": "string", + "format": "date-time" + }, + "last_deleted": { + "title": "Last deleted", + "description": "When the host was last deleted", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "automated_counter": { + "title": "Automated counter", + "description": "How many times was the host automated", + "type": "integer", + "default": 0, + "maximum": 9223372036854775807, + "minimum": -9223372036854775808 + }, + "deleted_counter": { + "title": "Deleted counter", + "description": "How many times was the host deleted", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "deleted": { + "title": "Deleted", + "description": "Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "used_in_inventories": { + "title": "Used in inventories", + "description": "How many inventories contain this host", + "type": "integer", + "maximum": 2147483647, + "minimum": -2147483648, + "x-nullable": true + } + } + }, + "AnsibleFacts": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "Inventory": { + "required": ["name", "organization"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Organization containing this inventory.", + "type": "integer", + "x-nullable": true + }, + "kind": { + "title": "Kind", + "description": "Kind of inventory being represented.", + "type": "string", + "enum": ["", "smart", "constructed"], + "default": "", + "x-nullable": true + }, + "host_filter": { + "title": "Host filter", + "description": "Filter that will be applied to the hosts of this inventory.", + "type": "string", + "x-nullable": true + }, + "variables": { + "title": "Variables", + "description": "Inventory variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "has_active_failures": { + "title": "Has active failures", + "description": "This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.", + "type": "boolean", + "readOnly": true + }, + "total_hosts": { + "title": "Total hosts", + "description": "This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "hosts_with_active_failures": { + "title": "Hosts with active failures", + "description": "This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "total_groups": { + "title": "Total groups", + "description": "This field is deprecated and will be removed in a future release. Total number of groups in this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "has_inventory_sources": { + "title": "Has inventory sources", + "description": "This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.", + "type": "boolean", + "readOnly": true + }, + "total_inventory_sources": { + "title": "Total inventory sources", + "description": "Total number of external inventory sources configured within this inventory.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "inventory_sources_with_failures": { + "title": "Inventory sources with failures", + "description": "Number of external inventory sources in this inventory with failures.", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "pending_deletion": { + "title": "Pending deletion", + "description": "Flag indicating the inventory is being deleted.", + "type": "boolean", + "readOnly": true + }, + "prevent_instance_group_fallback": { + "title": "Prevent instance group fallback", + "description": "If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", + "type": "boolean", + "default": false, + "x-nullable": true + } + } + }, + "HostVariableData": { + "type": "object", + "properties": { + "variables": { + "title": "Variables", + "description": "Host variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "InstanceGroup": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 250, + "minLength": 1, + "x-nullable": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "capacity": { "title": "Capacity", "type": "string", "readOnly": true }, + "consumed_capacity": { + "title": "Consumed capacity", + "type": "string", + "readOnly": true + }, + "percent_capacity_remaining": { + "title": "Percent capacity remaining", + "type": "string", + "readOnly": true + }, + "jobs_running": { + "title": "Jobs running", + "type": "string", + "readOnly": true + }, + "max_concurrent_jobs": { + "title": "Max Concurrent Jobs", + "description": "Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "max_forks": { + "title": "Max Forks", + "description": "Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "jobs_total": { + "title": "Jobs total", + "description": "Count of all jobs that target this instance group", + "type": "integer", + "readOnly": true + }, + "instances": { + "title": "Instances", + "type": "string", + "readOnly": true + }, + "is_container_group": { + "title": "Is container group", + "description": "Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.", + "type": "boolean" + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "policy_instance_percentage": { + "title": "Policy Instance Percentage", + "description": "Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.", + "type": "integer", + "default": 0, + "maximum": 100, + "minimum": 0 + }, + "policy_instance_minimum": { + "title": "Policy Instance Minimum", + "description": "Static minimum number of Instances that will be automatically assign to this group when new instances come online.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "policy_instance_list": { + "description": "List of exact-match Instances that will be assigned to this group", + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "pod_spec_override": { + "title": "Pod spec override", + "type": "string", + "default": "", + "x-nullable": true + }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + } + } + }, + "Instance": { + "required": ["hostname"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "hostname": { + "title": "Hostname", + "type": "string", + "maxLength": 250, + "minLength": 1, + "x-nullable": true + }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "last_seen": { + "title": "Last seen", + "description": "Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "health_check_started": { + "title": "Health check started", + "description": "The last time a health check was initiated on this instance.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "health_check_pending": { + "title": "Health check pending", + "type": "string", + "readOnly": true + }, + "last_health_check": { + "title": "Last health check", + "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "errors": { + "title": "Errors", + "description": "Any error details from the last health check.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "capacity_adjustment": { + "title": "Capacity adjustment", + "type": "string", + "format": "decimal", + "default": "1.00" + }, + "version": { + "title": "Version", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "capacity": { + "title": "Capacity", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "consumed_capacity": { + "title": "Consumed capacity", + "type": "string", + "readOnly": true + }, + "percent_capacity_remaining": { + "title": "Percent capacity remaining", + "type": "string", + "readOnly": true + }, + "jobs_running": { + "title": "Jobs running", + "description": "Count of jobs in the running or waiting state that are targeted for this instance", + "type": "integer", + "readOnly": true + }, + "jobs_total": { + "title": "Jobs total", + "description": "Count of all jobs that target this instance", + "type": "integer", + "readOnly": true + }, + "cpu": { + "title": "Cpu", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "memory": { + "title": "Memory", + "description": "Total system memory of this instance in bytes.", + "type": "integer", + "readOnly": true + }, + "cpu_capacity": { + "title": "Cpu capacity", + "type": "integer", + "readOnly": true + }, + "mem_capacity": { + "title": "Mem capacity", + "type": "integer", + "readOnly": true + }, + "enabled": { + "title": "Enabled", + "type": "boolean", + "default": true, + "x-nullable": true + }, + "managed_by_policy": { + "title": "Managed by policy", + "type": "boolean", + "default": true, + "x-nullable": true + }, + "node_type": { + "title": "Node type", + "description": "Role that this node plays in the mesh.", + "type": "string", + "enum": ["control", "execution", "hybrid", "hop"], + "default": "execution", + "x-nullable": true + }, + "node_state": { + "title": "Node state", + "description": "Indicates the current life cycle stage of this instance.", + "type": "string", + "enum": [ + "provisioning", + "provision-fail", + "installed", + "ready", + "unavailable", + "deprovisioning", + "deprovision-fail" + ], + "default": "installed", + "x-nullable": true + }, + "managed": { + "title": "Managed", + "description": "If True, this instance is managed by the control plane.", + "type": "boolean", + "readOnly": true + }, + "ip_address": { + "title": "Ip address", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "peers": { + "description": "Primary keys of receptor addresses to peer to.", + "type": "array", + "items": { + "description": "Primary keys of receptor addresses to peer to.", + "type": "integer" + }, + "uniqueItems": true + }, + "reverse_peers": { + "title": "Reverse peers", + "type": "string", + "readOnly": true + }, + "listener_port": { + "title": "Listener port", + "type": "integer", + "x-nullable": true + }, + "peers_from_control_nodes": { + "title": "Peers from control nodes", + "type": "boolean" + }, + "protocol": { "title": "Protocol", "type": "string", "readOnly": true } + } + }, + "UnifiedJobList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + } + } + }, + "InstanceHealthCheck": { + "type": "object", + "properties": { + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "hostname": { + "title": "Hostname", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "ip_address": { + "title": "Ip address", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "version": { + "title": "Version", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "last_health_check": { + "title": "Last health check", + "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "errors": { + "title": "Errors", + "description": "Any error details from the last health check.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "cpu": { + "title": "Cpu", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "memory": { + "title": "Memory", + "description": "Total system memory of this instance in bytes.", + "type": "integer", + "readOnly": true + }, + "cpu_capacity": { + "title": "Cpu capacity", + "type": "integer", + "readOnly": true + }, + "mem_capacity": { + "title": "Mem capacity", + "type": "integer", + "readOnly": true + }, + "capacity": { "title": "Capacity", "type": "integer", "readOnly": true } + } + }, + "ReceptorAddress": { + "required": ["address", "instance"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "address": { + "title": "Address", + "description": "Routable address for this instance.", + "type": "string", + "maxLength": 255, + "minLength": 1, + "x-nullable": true + }, + "port": { + "title": "Port", + "description": "Port for the address.", + "type": "integer", + "default": 27199, + "maximum": 65535, + "minimum": 0 + }, + "protocol": { + "title": "Protocol", + "description": "Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'.", + "type": "string", + "enum": ["tcp", "ws", "wss"], + "default": "tcp", + "x-nullable": true + }, + "websocket_path": { + "title": "Websocket path", + "description": "Websocket path.", + "type": "string", + "default": "", + "maxLength": 255, + "x-nullable": true + }, + "is_internal": { + "title": "Is internal", + "description": "If True, only routable within the Kubernetes cluster.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "canonical": { + "title": "Canonical", + "description": "If True, this address is the canonical address for the instance.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "instance": { "title": "Instance", "type": "integer" }, + "peers_from_control_nodes": { + "title": "Peers from control nodes", + "description": "If True, control plane cluster nodes should automatically peer to it.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "full_address": { + "title": "Full address", + "type": "string", + "readOnly": true + } + } + }, + "JobTemplate": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "default": "run", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "project": { "title": "Project", "type": "string", "x-nullable": true }, + "playbook": { + "title": "Playbook", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "limit": { + "title": "Limit", + "type": "string", + "default": "", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5], + "default": 0 + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "default": "", + "x-nullable": true + }, + "force_handlers": { + "title": "Force handlers", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "start_at_task": { + "title": "Start at task", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "use_fact_cache": { + "title": "Use fact cache", + "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this template.", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "host_config_key": { + "title": "Host config key", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "ask_scm_branch_on_launch": { + "title": "Ask scm branch on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_diff_mode_on_launch": { + "title": "Ask diff mode on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_variables_on_launch": { + "title": "Ask variables on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_limit_on_launch": { + "title": "Ask limit on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_tags_on_launch": { + "title": "Ask tags on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_skip_tags_on_launch": { + "title": "Ask skip tags on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_job_type_on_launch": { + "title": "Ask job type on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_verbosity_on_launch": { + "title": "Ask verbosity on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_inventory_on_launch": { + "title": "Ask inventory on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_credential_on_launch": { + "title": "Ask credential on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_execution_environment_on_launch": { + "title": "Ask execution environment on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_labels_on_launch": { + "title": "Ask labels on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_forks_on_launch": { + "title": "Ask forks on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_job_slice_count_on_launch": { + "title": "Ask job slice count on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_timeout_on_launch": { + "title": "Ask timeout on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_instance_groups_on_launch": { + "title": "Ask instance groups on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "survey_enabled": { + "title": "Survey enabled", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "become_enabled": { + "title": "Become enabled", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "diff_mode": { + "title": "Diff mode", + "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "description": "Local absolute file path containing a custom Python virtualenv to use", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "description": "The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.", + "type": "integer", + "default": 1, + "maximum": 2147483647, + "minimum": 0 + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "prevent_instance_group_fallback": { + "title": "Prevent instance group fallback", + "description": "If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.", + "type": "boolean", + "default": false, + "x-nullable": true + } + } + }, + "Label": { + "required": ["name", "organization"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Organization this label belongs to.", + "type": "integer" + } + } + }, + "InventoryScript": { "type": "object", "properties": {} }, + "GroupTree": { + "required": ["name", "inventory"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "inventory": { "title": "Inventory", "type": "integer" }, + "variables": { + "title": "Variables", + "description": "Group variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "children": { "title": "Children", "type": "string", "readOnly": true } + } + }, + "InventorySourceUpdate": { + "type": "object", + "properties": { + "can_update": { + "title": "Can update", + "type": "boolean", + "readOnly": true + } + } + }, + "InventoryVariableData": { + "type": "object", + "properties": { + "variables": { + "title": "Variables", + "description": "Inventory variables in JSON or YAML format.", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "InventoryUpdateList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "source": { + "title": "Source", + "type": "string", + "enum": [ + "file", + "constructed", + "scm", + "ec2", + "gce", + "azure_rm", + "vmware", + "satellite6", + "openstack", + "rhv", + "controller", + "insights", + "terraform", + "openshift_virtualization" + ], + "x-nullable": true + }, + "source_path": { + "title": "Source path", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "source_vars": { + "title": "Source vars", + "description": "Inventory source variables in YAML or JSON format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "description": "Cloud credential to use for inventory updates.", + "type": "integer", + "minimum": 1, + "x-nullable": true + }, + "enabled_var": { + "title": "Enabled var", + "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", + "type": "string", + "default": "", + "x-nullable": true + }, + "enabled_value": { + "title": "Enabled value", + "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", + "type": "string", + "default": "", + "x-nullable": true + }, + "host_filter": { + "title": "Host filter", + "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", + "type": "string", + "default": "", + "x-nullable": true + }, + "overwrite": { + "title": "Overwrite", + "description": "Overwrite local groups and hosts from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "overwrite_vars": { + "title": "Overwrite vars", + "description": "Overwrite local variables from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "type": "string", + "readOnly": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2], + "default": 1 + }, + "limit": { + "title": "Limit", + "description": "Enter host, group or pattern match", + "type": "string", + "default": "", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "inventory_source": { + "title": "Inventory source", + "type": "string", + "readOnly": true + }, + "license_error": { + "title": "License error", + "type": "boolean", + "readOnly": true + }, + "org_host_limit_error": { + "title": "Org host limit error", + "type": "boolean", + "readOnly": true + }, + "source_project_update": { + "title": "Source project update", + "description": "Inventory files from this Project Update were used for the inventory update.", + "type": "string", + "x-nullable": true + }, + "instance_group": { + "title": "Instance group", + "description": "The Instance group the job was run under", + "type": "integer", + "x-nullable": true + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", + "type": "string", + "readOnly": true, + "minLength": 1 + } + } + }, + "NotificationTemplate": { + "required": ["name", "organization", "notification_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "type": "integer", + "x-nullable": true + }, + "notification_type": { + "title": "Notification type", + "type": "string", + "enum": [ + "awssns", + "email", + "grafana", + "irc", + "mattermost", + "pagerduty", + "rocketchat", + "slack", + "twilio", + "webhook" + ], + "x-nullable": true + }, + "notification_configuration": { + "title": "Notification configuration", + "type": "object", + "default": {} + }, + "messages": { + "title": "Messages", + "description": "Optional custom messages for notification template.", + "type": "object", + "default": { + "started": null, + "success": null, + "error": null, + "workflow_approval": null + }, + "x-nullable": true + } + } + }, + "Schedule": { + "required": ["rrule", "name", "unified_job_template"], + "type": "object", + "properties": { + "rrule": { + "title": "Rrule", + "description": "A value representing the schedules iCal recurrence rule.", + "type": "string", + "minLength": 1, + "x-nullable": true + }, + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "unified_job_template": { + "title": "Unified job template", + "type": "integer" + }, + "enabled": { + "title": "Enabled", + "description": "Enables processing of this schedule.", + "type": "boolean", + "default": true, + "x-nullable": true + }, + "dtstart": { + "title": "Dtstart", + "description": "The first occurrence of the schedule occurs on or after this time.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "dtend": { + "title": "Dtend", + "description": "The last occurrence of the schedule occurs before this time, aftewards the schedule expires.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "next_run": { + "title": "Next run", + "description": "The next time that the scheduled action will run.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "timezone": { + "title": "Timezone", + "description": "The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.", + "type": "string", + "readOnly": true + }, + "until": { + "title": "Until", + "description": "The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned", + "type": "string", + "readOnly": true + } + } + }, + "InventoryUpdateDetail": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "source": { + "title": "Source", + "type": "string", + "enum": [ + "file", + "constructed", + "scm", + "ec2", + "gce", + "azure_rm", + "vmware", + "satellite6", + "openstack", + "rhv", + "controller", + "insights", + "terraform", + "openshift_virtualization" + ], + "x-nullable": true + }, + "source_path": { + "title": "Source path", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "source_vars": { + "title": "Source vars", + "description": "Inventory source variables in YAML or JSON format.", + "type": "string", + "default": "", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "description": "Cloud credential to use for inventory updates.", + "type": "integer", + "minimum": 1, + "x-nullable": true + }, + "enabled_var": { + "title": "Enabled var", + "description": "Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)", + "type": "string", + "default": "", + "x-nullable": true + }, + "enabled_value": { + "title": "Enabled value", + "description": "Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{ \"status\": { \"power_state\": \"powered_on\", \"created\": \"2020-08-04T18:13:04+00:00\", \"healthy\": true }, \"name\": \"foobar\", \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled", + "type": "string", + "default": "", + "x-nullable": true + }, + "host_filter": { + "title": "Host filter", + "description": "This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.", + "type": "string", + "default": "", + "x-nullable": true + }, + "overwrite": { + "title": "Overwrite", + "description": "Overwrite local groups and hosts from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "overwrite_vars": { + "title": "Overwrite vars", + "description": "Overwrite local variables from remote inventory source.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "type": "string", + "readOnly": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2], + "default": 1 + }, + "limit": { + "title": "Limit", + "description": "Enter host, group or pattern match", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "inventory_source": { + "title": "Inventory source", + "type": "string", + "readOnly": true + }, + "license_error": { + "title": "License error", + "type": "boolean", + "readOnly": true + }, + "org_host_limit_error": { + "title": "Org host limit error", + "type": "boolean", + "readOnly": true + }, + "source_project_update": { + "title": "Source project update", + "description": "Inventory files from this Project Update were used for the inventory update.", + "type": "string", + "x-nullable": true + }, + "instance_group": { + "title": "Instance group", + "description": "The Instance group the job was run under", + "type": "integer", + "x-nullable": true + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "source_project": { + "title": "Source project", + "description": "The project used for this job.", + "type": "string", + "readOnly": true + } + } + }, + "InventoryUpdateCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + }, + "InventoryUpdateEvent": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "event": { "title": "Event", "type": "string", "readOnly": true }, + "counter": { + "title": "Counter", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "event_display": { + "title": "Event display", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_data": { + "title": "Event data", + "type": "object", + "default": {} + }, + "failed": { "title": "Failed", "type": "string", "readOnly": true }, + "changed": { "title": "Changed", "type": "string", "readOnly": true }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "stdout": { + "title": "Stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "start_line": { + "title": "Start line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "end_line": { + "title": "End line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "inventory_update": { + "title": "Inventory update", + "type": "string", + "readOnly": true + } + } + }, + "JobList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check", "scan"], + "default": "run", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "project": { "title": "Project", "type": "string", "x-nullable": true }, + "playbook": { + "title": "Playbook", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "limit": { + "title": "Limit", + "type": "string", + "default": "", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5], + "default": 0 + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "default": "", + "x-nullable": true + }, + "force_handlers": { + "title": "Force handlers", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "start_at_task": { + "title": "Start at task", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "use_fact_cache": { + "title": "Use fact cache", + "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this unified job.", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "job_template": { + "title": "Job template", + "type": "string", + "x-nullable": true + }, + "passwords_needed_to_start": { + "title": "Passwords needed to start", + "type": "string", + "readOnly": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "artifacts": { + "title": "Artifacts", + "type": "string", + "readOnly": true + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision from the Project used for this job, if available", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "instance_group": { + "title": "Instance group", + "description": "The Instance group the job was run under", + "type": "integer", + "x-nullable": true + }, + "diff_mode": { + "title": "Diff mode", + "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "job_slice_number": { + "title": "Job slice number", + "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "job_slice_count": { + "title": "Job slice count", + "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", + "type": "integer", + "default": 1, + "maximum": 2147483647, + "minimum": 0 + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "webhook_guid": { + "title": "Webhook guid", + "description": "Unique identifier of the event that triggered this webhook", + "type": "string", + "maxLength": 128, + "x-nullable": true + } + } + }, + "JobLaunch": { + "type": "object", + "properties": { + "can_start_without_user_input": { + "title": "Can start without user input", + "type": "boolean", + "readOnly": true + }, + "passwords_needed_to_start": { + "title": "Passwords needed to start", + "type": "string", + "readOnly": true + }, + "extra_vars": { "title": "Extra vars", "type": "object" }, + "inventory": { "title": "Inventory", "type": "integer" }, + "scm_branch": { "title": "Scm branch", "type": "string" }, + "limit": { "title": "Limit", "type": "string" }, + "job_tags": { "title": "Job tags", "type": "string" }, + "skip_tags": { "title": "Skip tags", "type": "string" }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"] + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5] + }, + "diff_mode": { "title": "Diff mode", "type": "boolean" }, + "credentials": { + "type": "array", + "items": { "type": "integer" }, + "uniqueItems": true + }, + "credential_passwords": { + "title": "Credential passwords", + "type": "string" + }, + "ask_scm_branch_on_launch": { + "title": "Ask scm branch on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_variables_on_launch": { + "title": "Ask variables on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_tags_on_launch": { + "title": "Ask tags on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_diff_mode_on_launch": { + "title": "Ask diff mode on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_skip_tags_on_launch": { + "title": "Ask skip tags on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_job_type_on_launch": { + "title": "Ask job type on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_limit_on_launch": { + "title": "Ask limit on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_verbosity_on_launch": { + "title": "Ask verbosity on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_inventory_on_launch": { + "title": "Ask inventory on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_credential_on_launch": { + "title": "Ask credential on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_execution_environment_on_launch": { + "title": "Ask execution environment on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_labels_on_launch": { + "title": "Ask labels on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_forks_on_launch": { + "title": "Ask forks on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_job_slice_count_on_launch": { + "title": "Ask job slice count on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_timeout_on_launch": { + "title": "Ask timeout on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_instance_groups_on_launch": { + "title": "Ask instance groups on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "survey_enabled": { + "title": "Survey enabled", + "type": "string", + "readOnly": true + }, + "variables_needed_to_start": { + "title": "Variables needed to start", + "type": "string", + "readOnly": true + }, + "credential_needed_to_start": { + "title": "Credential needed to start", + "type": "string", + "readOnly": true + }, + "inventory_needed_to_start": { + "title": "Inventory needed to start", + "type": "string", + "readOnly": true + }, + "job_template_data": { + "title": "Job template data", + "type": "string", + "readOnly": true + }, + "defaults": { "title": "Defaults", "type": "string", "readOnly": true }, + "execution_environment": { + "title": "Execution environment", + "type": "integer" + }, + "labels": { + "type": "array", + "items": { "type": "integer" }, + "uniqueItems": true + }, + "forks": { "title": "Forks", "type": "integer", "minimum": 0 }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0 + }, + "timeout": { "title": "Timeout", "type": "integer" }, + "instance_groups": { + "type": "array", + "items": { "type": "integer" }, + "uniqueItems": true + } + } + }, + "WorkflowJobList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "workflow_job_template": { + "title": "Workflow job template", + "type": "string", + "x-nullable": true + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "job_template": { + "title": "Job template", + "description": "If automatically created for a sliced job run, the job template the workflow job was created from.", + "type": "string", + "x-nullable": true + }, + "is_sliced_job": { + "title": "Is sliced job", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "webhook_guid": { + "title": "Webhook guid", + "description": "Unique identifier of the event that triggered this webhook", + "type": "string", + "maxLength": 128, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + } + } + }, + "JobDetail": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check", "scan"], + "default": "run", + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "type": "integer", + "x-nullable": true + }, + "project": { "title": "Project", "type": "string", "x-nullable": true }, + "playbook": { + "title": "Playbook", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "description": "Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "limit": { + "title": "Limit", + "type": "string", + "default": "", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "enum": [0, 1, 2, 3, 4, 5], + "default": 0 + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "default": "", + "x-nullable": true + }, + "force_handlers": { + "title": "Force handlers", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "start_at_task": { + "title": "Start at task", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "use_fact_cache": { + "title": "Use fact cache", + "description": "If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this unified job.", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "controller_node": { + "title": "Controller node", + "description": "The instance that managed the execution environment.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "job_template": { + "title": "Job template", + "type": "string", + "x-nullable": true + }, + "passwords_needed_to_start": { + "title": "Passwords needed to start", + "type": "string", + "readOnly": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "artifacts": { + "title": "Artifacts", + "type": "string", + "readOnly": true + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision from the Project used for this job, if available", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "instance_group": { + "title": "Instance group", + "description": "The Instance group the job was run under", + "type": "integer", + "x-nullable": true + }, + "diff_mode": { + "title": "Diff mode", + "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "job_slice_number": { + "title": "Job slice number", + "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "job_slice_count": { + "title": "Job slice count", + "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.", + "type": "integer", + "default": 1, + "maximum": 2147483647, + "minimum": 0 + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "webhook_guid": { + "title": "Webhook guid", + "description": "Unique identifier of the event that triggered this webhook", + "type": "string", + "maxLength": 128, + "x-nullable": true + }, + "host_status_counts": { + "title": "Host status counts", + "description": "Playbook stats from the Ansible playbook_on_stats event.", + "type": "object", + "readOnly": true, + "x-nullable": true + }, + "playbook_counts": { + "title": "Playbook counts", + "description": "A count of all plays and tasks for the job run.", + "type": "string", + "readOnly": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "type": "string", + "readOnly": true + } + } + }, + "JobCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + }, + "JobCreateSchedule": { + "type": "object", + "properties": { + "can_schedule": { + "title": "Can schedule", + "type": "string", + "readOnly": true + }, + "prompts": { "title": "Prompts", "type": "string", "readOnly": true } + } + }, + "JobRelaunch": { + "required": ["credential_passwords"], + "type": "object", + "properties": { + "passwords_needed_to_start": { + "title": "Passwords needed to start", + "type": "string", + "readOnly": true + }, + "retry_counts": { + "title": "Retry counts", + "type": "string", + "readOnly": true + }, + "hosts": { + "title": "Hosts", + "type": "string", + "enum": ["all", "failed"], + "default": "all", + "x-nullable": true + }, + "credential_passwords": { + "title": "Credential passwords", + "type": "string" + } + } + }, + "Organization": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "max_hosts": { + "title": "Max hosts", + "description": "Maximum number of hosts allowed to be managed by this organization.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "description": "Local absolute file path containing a custom Python virtualenv to use", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "default_environment": { + "title": "Default environment", + "description": "The default execution environment for jobs run by this organization.", + "type": "integer", + "x-nullable": true + } + } + }, + "OrganizationCredentialSerializerCreate": { + "required": ["name", "credential_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team.", + "type": "integer", + "x-nullable": true + }, + "credential_type": { + "title": "Credential Type", + "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", + "type": "integer" + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "kind": { "title": "Kind", "type": "string", "readOnly": true }, + "cloud": { "title": "Cloud", "type": "string", "readOnly": true }, + "kubernetes": { + "title": "Kubernetes", + "type": "string", + "readOnly": true + } + } + }, + "Project": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "local_path": { + "title": "Local path", + "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", + "type": "string", + "maxLength": 1024, + "x-nullable": true + }, + "scm_type": { + "title": "SCM Type", + "description": "Specifies the source control system used to store the project.", + "type": "string", + "enum": ["", "git", "svn", "insights", "archive"], + "default": "", + "x-nullable": true + }, + "scm_url": { + "title": "SCM URL", + "description": "The location where the project is stored.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "SCM Branch", + "description": "Specific branch, tag or commit to checkout.", + "type": "string", + "default": "", + "maxLength": 256, + "x-nullable": true + }, + "scm_refspec": { + "title": "SCM refspec", + "description": "For git projects, an additional refspec to fetch.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_clean": { + "title": "Scm clean", + "description": "Discard any local changes before syncing the project.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_track_submodules": { + "title": "Scm track submodules", + "description": "Track submodules latest commits on defined branch.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_delete_on_update": { + "title": "Scm delete on update", + "description": "Delete the project before syncing.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The last revision fetched by a project update", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "ok", + "missing" + ], + "readOnly": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this template.", + "type": "integer", + "x-nullable": true + }, + "scm_update_on_launch": { + "title": "Scm update on launch", + "description": "Update the project when a job is launched that uses the project.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_update_cache_timeout": { + "title": "Scm update cache timeout", + "description": "The number of seconds after the last project update ran that a new project update will be launched as a job dependency.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + "allow_override": { + "title": "Allow override", + "description": "Allow changing the SCM branch or revision in a job template that uses this project.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "custom_virtualenv": { + "title": "Custom virtualenv", + "description": "Local absolute file path containing a custom Python virtualenv to use", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "default_environment": { + "title": "Default environment", + "description": "The default execution environment for jobs run using this project.", + "type": "integer", + "x-nullable": true + }, + "signature_validation_credential": { + "title": "Signature validation credential", + "description": "An optional credential used for validating files in the project against unexpected changes.", + "type": "integer", + "x-nullable": true + }, + "last_update_failed": { + "title": "Last update failed", + "type": "boolean", + "readOnly": true + }, + "last_updated": { + "title": "Last updated", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "WorkflowJobTemplate": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "ok", + "missing", + "none", + "updating" + ], + "readOnly": true + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "organization": { + "title": "Organization", + "description": "The organization used to determine access to this template.", + "type": "integer", + "x-nullable": true + }, + "survey_enabled": { + "title": "Survey enabled", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_variables_on_launch": { + "title": "Ask variables on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "ask_inventory_on_launch": { + "title": "Ask inventory on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_scm_branch_on_launch": { + "title": "Ask scm branch on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_limit_on_launch": { + "title": "Ask limit on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "ask_labels_on_launch": { + "title": "Ask labels on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_skip_tags_on_launch": { + "title": "Ask skip tags on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "ask_tags_on_launch": { + "title": "Ask tags on launch", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + } + } + }, + "ProjectUpdateList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "local_path": { + "title": "Local path", + "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", + "type": "string", + "maxLength": 1024, + "x-nullable": true + }, + "scm_type": { + "title": "SCM Type", + "description": "Specifies the source control system used to store the project.", + "type": "string", + "enum": ["", "git", "svn", "insights", "archive"], + "default": "", + "x-nullable": true + }, + "scm_url": { + "title": "SCM URL", + "description": "The location where the project is stored.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "SCM Branch", + "description": "Specific branch, tag or commit to checkout.", + "type": "string", + "default": "", + "maxLength": 256, + "x-nullable": true + }, + "scm_refspec": { + "title": "SCM refspec", + "description": "For git projects, an additional refspec to fetch.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_clean": { + "title": "Scm clean", + "description": "Discard any local changes before syncing the project.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_track_submodules": { + "title": "Scm track submodules", + "description": "Track submodules latest commits on defined branch.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_delete_on_update": { + "title": "Scm delete on update", + "description": "Delete the project before syncing.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision discovered by this update for the given project and branch.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "project": { "title": "Project", "type": "string", "readOnly": true }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "default": "check", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "description": "Parts of the project update playbook that will be run.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + } + } + }, + "ProjectUpdateDetail": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "local_path": { + "title": "Local path", + "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", + "type": "string", + "maxLength": 1024, + "x-nullable": true + }, + "scm_type": { + "title": "SCM Type", + "description": "Specifies the source control system used to store the project.", + "type": "string", + "enum": ["", "git", "svn", "insights", "archive"], + "default": "", + "x-nullable": true + }, + "scm_url": { + "title": "SCM URL", + "description": "The location where the project is stored.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_branch": { + "title": "SCM Branch", + "description": "Specific branch, tag or commit to checkout.", + "type": "string", + "default": "", + "maxLength": 256, + "x-nullable": true + }, + "scm_refspec": { + "title": "SCM refspec", + "description": "For git projects, an additional refspec to fetch.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "scm_clean": { + "title": "Scm clean", + "description": "Discard any local changes before syncing the project.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_track_submodules": { + "title": "Scm track submodules", + "description": "Track submodules latest commits on defined branch.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "scm_delete_on_update": { + "title": "Scm delete on update", + "description": "Delete the project before syncing.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "credential": { + "title": "Credential", + "type": "integer", + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) to run before the task is canceled.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "scm_revision": { + "title": "SCM Revision", + "description": "The SCM Revision discovered by this update for the given project and branch.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "project": { "title": "Project", "type": "string", "readOnly": true }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "default": "check", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "description": "Parts of the project update playbook that will be run.", + "type": "string", + "default": "", + "maxLength": 1024, + "x-nullable": true + }, + "host_status_counts": { + "title": "Host status counts", + "description": "Playbook stats from the Ansible playbook_on_stats event.", + "type": "object", + "readOnly": true, + "x-nullable": true + }, + "playbook_counts": { + "title": "Playbook counts", + "description": "A count of all plays and tasks for the job run.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectUpdateCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + }, + "ProjectUpdateEvent": { + "required": ["event"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "event": { + "title": "Event", + "type": "string", + "enum": [ + "runner_on_failed", + "runner_on_start", + "runner_on_ok", + "runner_on_error", + "runner_on_skipped", + "runner_on_unreachable", + "runner_on_no_hosts", + "runner_on_async_poll", + "runner_on_async_ok", + "runner_on_async_failed", + "runner_item_on_ok", + "runner_item_on_failed", + "runner_item_on_skipped", + "runner_retry", + "runner_on_file_diff", + "playbook_on_start", + "playbook_on_notify", + "playbook_on_include", + "playbook_on_no_hosts_matched", + "playbook_on_no_hosts_remaining", + "playbook_on_task_start", + "playbook_on_vars_prompt", + "playbook_on_setup", + "playbook_on_import_for_host", + "playbook_on_not_import_for_host", + "playbook_on_play_start", + "playbook_on_stats", + "debug", + "verbose", + "deprecated", + "warning", + "system_warning", + "error" + ], + "x-nullable": true + }, + "counter": { + "title": "Counter", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "event_display": { + "title": "Event display", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_data": { + "title": "Event data", + "type": "string", + "readOnly": true + }, + "event_level": { + "title": "Event level", + "type": "integer", + "readOnly": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "changed": { "title": "Changed", "type": "boolean", "readOnly": true }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "host_name": { + "title": "Host name", + "type": "string", + "readOnly": true + }, + "playbook": { + "title": "Playbook", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "play": { + "title": "Play", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "task": { + "title": "Task", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "role": { + "title": "Role", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "stdout": { "title": "Stdout", "type": "string", "readOnly": true }, + "start_line": { + "title": "Start line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "end_line": { + "title": "End line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "project_update": { + "title": "Project update", + "type": "string", + "readOnly": true + } + } + }, + "ProjectInventories": { + "type": "object", + "properties": { + "inventory_files": { + "title": "Inventory files", + "description": "Array of inventory files and directories available within this project, not comprehensive.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectPlaybooks": { + "type": "object", + "properties": { + "playbooks": { + "title": "Playbooks", + "description": "Array of playbooks available within this project.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectUpdateView": { + "type": "object", + "properties": { + "can_update": { + "title": "Can update", + "type": "boolean", + "readOnly": true + } + } + }, + "SchedulePreview": { + "required": ["rrule"], + "type": "object", + "properties": { + "rrule": { + "title": "Rrule", + "description": "A value representing the schedules iCal recurrence rule.", + "type": "string", + "minLength": 1, + "x-nullable": true + } + } + }, + "SettingCategory": { + "type": "object", + "properties": { + "url": { + "title": "Url", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "slug": { + "title": "Slug", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "name": { + "title": "Name", + "type": "string", + "readOnly": true, + "minLength": 1 + } + } + }, + "SettingSingleton": { + "required": [ + "ACTIVITY_STREAM_ENABLED", + "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC", + "ORG_ADMINS_CAN_SEE_ALL_USERS", + "MANAGE_ORGANIZATION_AUTH", + "TOWER_URL_BASE", + "REMOTE_HOST_HEADERS", + "ALLOW_JINJA_IN_EXTRA_VARS", + "AWX_ISOLATION_BASE_PATH", + "AWX_RUNNER_KEEPALIVE_SECONDS", + "GALAXY_TASK_ENV", + "PROJECT_UPDATE_VVV", + "STDOUT_MAX_BYTES_DISPLAY", + "EVENT_STDOUT_MAX_BYTES_DISPLAY", + "SCHEDULE_MAX_JOBS", + "CLEANUP_HOST_METRICS_LAST_TS", + "HOST_METRIC_SUMMARY_TASK_LAST_TS", + "SESSION_COOKIE_AGE", + "SESSIONS_PER_USER", + "DISABLE_LOCAL_AUTH", + "AUTH_BASIC_ENABLED", + "MAX_UI_JOB_EVENTS", + "UI_LIVE_UPDATES_ENABLED", + "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT", + "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY", + "SOCIAL_AUTH_SAML_ORG_INFO", + "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT", + "SOCIAL_AUTH_SAML_SUPPORT_CONTACT" + ], + "type": "object", + "properties": { + "ACTIVITY_STREAM_ENABLED": { + "title": "Enable Activity Stream", + "description": "Enable capturing activity for the activity stream.", + "type": "boolean", + "default": true + }, + "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC": { + "title": "Enable Activity Stream for Inventory Sync", + "description": "Enable capturing activity for the activity stream when running inventory sync.", + "type": "boolean", + "default": false + }, + "ORG_ADMINS_CAN_SEE_ALL_USERS": { + "title": "All Users Visible to Organization Admins", + "description": "Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization.", + "type": "boolean", + "default": true + }, + "MANAGE_ORGANIZATION_AUTH": { + "title": "Organization Admins Can Manage Users and Teams", + "description": "Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration.", + "type": "boolean", + "default": true + }, + "TOWER_URL_BASE": { + "title": "Base URL of the service", + "description": "This setting is used by services like notifications to render a valid url to the service.", + "type": "string", + "default": "https://platformhost", + "minLength": 1 + }, + "REMOTE_HOST_HEADERS": { + "description": "HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if behind a reverse proxy. See the \"Proxy Support\" section of the AAP Installation guide for more details.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": ["REMOTE_ADDR", "REMOTE_HOST"] + }, + "PROXY_IP_ALLOWED_LIST": { + "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "CSRF_TRUSTED_ORIGINS": { + "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. ", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "LICENSE": { + "title": "License", + "description": "The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "readOnly": true, + "default": {} + }, + "REDHAT_USERNAME": { + "title": "Red Hat customer username", + "description": "This username is used to send data to Automation Analytics", + "type": "string", + "default": "" + }, + "REDHAT_PASSWORD": { + "title": "Red Hat customer password", + "description": "This password is used to send data to Automation Analytics", + "type": "string", + "default": "" + }, + "SUBSCRIPTIONS_USERNAME": { + "title": "Red Hat or Satellite username", + "description": "This username is used to retrieve subscription and content information", + "type": "string", + "default": "" + }, + "SUBSCRIPTIONS_PASSWORD": { + "title": "Red Hat or Satellite password", + "description": "This password is used to retrieve subscription and content information", + "type": "string", + "default": "" + }, + "AUTOMATION_ANALYTICS_URL": { + "title": "Automation Analytics upload URL", + "description": "This setting is used to to configure the upload URL for data collection for Automation Analytics.", + "type": "string", + "default": "https://example.com", + "minLength": 1 + }, + "INSTALL_UUID": { + "title": "Unique identifier for an installation", + "type": "string", + "readOnly": true, + "default": "00000000-0000-0000-0000-000000000000", + "minLength": 1 + }, + "DEFAULT_CONTROL_PLANE_QUEUE_NAME": { + "title": "The instance group where control plane tasks run", + "type": "string", + "readOnly": true, + "default": "controlplane", + "minLength": 1 + }, + "DEFAULT_EXECUTION_QUEUE_NAME": { + "title": "The instance group where user jobs run (currently only on non-VM installs)", + "type": "string", + "readOnly": true, + "default": "default", + "minLength": 1 + }, + "DEFAULT_EXECUTION_ENVIRONMENT": { + "title": "Global default execution environment", + "description": "The Execution Environment to be used when one has not been configured for a job template.", + "type": "integer", + "x-nullable": true + }, + "CUSTOM_VENV_PATHS": { + "description": "Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "AD_HOC_COMMANDS": { + "description": "List of modules allowed to be used by ad-hoc jobs.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [ + "command", + "shell", + "yum", + "apt", + "apt_key", + "apt_repository", + "apt_rpm", + "service", + "group", + "user", + "mount", + "ping", + "selinux", + "setup", + "win_ping", + "win_service", + "win_updates", + "win_group", + "win_user" + ] + }, + "ALLOW_JINJA_IN_EXTRA_VARS": { + "title": "When can extra variables contain Jinja templates?", + "description": "Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to \"template\" or \"never\".", + "type": "string", + "enum": ["always", "never", "template"], + "default": "template" + }, + "AWX_ISOLATION_BASE_PATH": { + "title": "Job execution path", + "description": "The directory in which the service will create new temporary directories for job execution and isolation (such as credential files).", + "type": "string", + "default": "/tmp", + "minLength": 1 + }, + "AWX_ISOLATION_SHOW_PATHS": { + "description": "List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. ", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "AWX_TASK_ENV": { + "title": "Extra Environment Variables", + "description": "Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AWX_RUNNER_KEEPALIVE_SECONDS": { + "title": "K8S Ansible Runner Keep-Alive Message Interval", + "description": "Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open.", + "type": "integer", + "default": 0 + }, + "GALAXY_TASK_ENV": { + "title": "Environment Variables for Galaxy Commands", + "description": "Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": { + "ANSIBLE_FORCE_COLOR": "false", + "GIT_SSH_COMMAND": "ssh -o StrictHostKeyChecking=no" + } + }, + "INSIGHTS_TRACKING_STATE": { + "title": "Gather data for Automation Analytics", + "description": "Enables the service to gather data on automation and send it to Automation Analytics.", + "type": "boolean", + "default": false + }, + "PROJECT_UPDATE_VVV": { + "title": "Run Project Updates With Higher Verbosity", + "description": "Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates.", + "type": "boolean", + "default": false + }, + "AWX_ROLES_ENABLED": { + "title": "Enable Role Download", + "description": "Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects.", + "type": "boolean", + "default": true + }, + "AWX_COLLECTIONS_ENABLED": { + "title": "Enable Collection(s) Download", + "description": "Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects.", + "type": "boolean", + "default": true + }, + "AWX_SHOW_PLAYBOOK_LINKS": { + "title": "Follow symlinks", + "description": "Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself.", + "type": "boolean", + "default": false + }, + "AWX_MOUNT_ISOLATED_PATHS_ON_K8S": { + "title": "Expose host paths for Container Groups", + "description": "Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. ", + "type": "boolean", + "default": false + }, + "GALAXY_IGNORE_CERTS": { + "title": "Ignore Ansible Galaxy SSL Certificate Verification", + "description": "If set to true, certificate validation will not be done when installing content from any Galaxy server.", + "type": "boolean", + "default": false + }, + "STDOUT_MAX_BYTES_DISPLAY": { + "title": "Standard Output Maximum Display Size", + "description": "Maximum Size of Standard Output in bytes to display before requiring the output be downloaded.", + "type": "integer", + "default": 1048576, + "minimum": 0 + }, + "EVENT_STDOUT_MAX_BYTES_DISPLAY": { + "title": "Job Event Standard Output Maximum Display Size", + "description": "Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated.", + "type": "integer", + "default": 1024, + "minimum": 0 + }, + "MAX_WEBSOCKET_EVENT_RATE": { + "title": "Job Event Maximum Websocket Messages Per Second", + "description": "Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit.", + "type": "integer", + "default": 30, + "minimum": 0 + }, + "SCHEDULE_MAX_JOBS": { + "title": "Maximum Scheduled Jobs", + "description": "Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created.", + "type": "integer", + "default": 10, + "minimum": 1 + }, + "AWX_ANSIBLE_CALLBACK_PLUGINS": { + "description": "List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "DEFAULT_JOB_TIMEOUT": { + "title": "Default Job Timeout", + "description": "Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "DEFAULT_JOB_IDLE_TIMEOUT": { + "title": "Default Job Idle Timeout", + "description": "If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "DEFAULT_INVENTORY_UPDATE_TIMEOUT": { + "title": "Default Inventory Update Timeout", + "description": "Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "DEFAULT_PROJECT_UPDATE_TIMEOUT": { + "title": "Default Project Update Timeout", + "description": "Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "ANSIBLE_FACT_CACHE_TIMEOUT": { + "title": "Per-Host Ansible Fact Cache Timeout", + "description": "Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed.", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "MAX_FORKS": { + "title": "Maximum number of forks per job", + "description": "Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied.", + "type": "integer", + "default": 200 + }, + "LOG_AGGREGATOR_HOST": { + "title": "Logging Aggregator", + "description": "Hostname/IP where external logs will be sent to.", + "type": "string", + "minLength": 1, + "x-nullable": true + }, + "LOG_AGGREGATOR_PORT": { + "title": "Logging Aggregator Port", + "description": "Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator).", + "type": "integer", + "x-nullable": true + }, + "LOG_AGGREGATOR_TYPE": { + "title": "Logging Aggregator Type", + "description": "Format messages for the chosen log aggregator.", + "type": "string", + "enum": ["logstash", "splunk", "loggly", "sumologic", "other"], + "x-nullable": true + }, + "LOG_AGGREGATOR_USERNAME": { + "title": "Logging Aggregator Username", + "description": "Username for external log aggregator (if required; HTTP/s only).", + "type": "string", + "default": "" + }, + "LOG_AGGREGATOR_PASSWORD": { + "title": "Logging Aggregator Password/Token", + "description": "Password or authentication token for external log aggregator (if required; HTTP/s only).", + "type": "string", + "default": "" + }, + "LOG_AGGREGATOR_LOGGERS": { + "description": "List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\n", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [ + "awx", + "activity_stream", + "job_events", + "system_tracking", + "broadcast_websocket" + ] + }, + "LOG_AGGREGATOR_INDIVIDUAL_FACTS": { + "title": "Log System Tracking Facts Individually", + "description": "If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing.", + "type": "boolean", + "default": false + }, + "LOG_AGGREGATOR_ENABLED": { + "title": "Enable External Logging", + "description": "Enable sending logs to external log aggregator.", + "type": "boolean", + "default": false + }, + "LOG_AGGREGATOR_TOWER_UUID": { + "title": "Cluster-wide unique identifier.", + "description": "Useful to uniquely identify instances.", + "type": "string", + "default": "" + }, + "LOG_AGGREGATOR_PROTOCOL": { + "title": "Logging Aggregator Protocol", + "description": "Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.", + "type": "string", + "enum": ["https", "tcp", "udp"], + "default": "https" + }, + "LOG_AGGREGATOR_TCP_TIMEOUT": { + "title": "TCP Connection Timeout", + "description": "Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols.", + "type": "integer", + "default": 5 + }, + "LOG_AGGREGATOR_VERIFY_CERT": { + "title": "Enable/disable HTTPS certificate verification", + "description": "Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection.", + "type": "boolean", + "default": true + }, + "LOG_AGGREGATOR_LEVEL": { + "title": "Logging Aggregator Level Threshold", + "description": "Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting)", + "type": "string", + "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], + "default": "INFO" + }, + "LOG_AGGREGATOR_ACTION_QUEUE_SIZE": { + "title": "Maximum number of messages that can be stored in the log action queue", + "description": "Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5).", + "type": "integer", + "default": 131072, + "minimum": 1 + }, + "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB": { + "title": "Maximum disk persistence for rsyslogd action queuing (in GB)", + "description": "Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH.", + "type": "integer", + "default": 1, + "minimum": 1 + }, + "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH": { + "title": "File system location for rsyslogd disk persistence", + "description": "Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting.", + "type": "string", + "default": "/var/lib/awx", + "minLength": 1 + }, + "LOG_AGGREGATOR_RSYSLOGD_DEBUG": { + "title": "Enable rsyslogd debugging", + "description": "Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation.", + "type": "boolean", + "default": false + }, + "API_400_ERROR_LOG_FORMAT": { + "title": "Log Format For API 4XX Errors", + "description": "The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}.", + "type": "string", + "default": "status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", + "minLength": 1 + }, + "AUTOMATION_ANALYTICS_LAST_GATHER": { + "title": "Last gather date for Automation Analytics.", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "AUTOMATION_ANALYTICS_LAST_ENTRIES": { + "title": "Last gathered entries from the data collection service of Automation Analytics", + "type": "string", + "default": "" + }, + "AUTOMATION_ANALYTICS_GATHER_INTERVAL": { + "title": "Automation Analytics Gather Interval", + "description": "Interval (in seconds) between data gathering.", + "type": "integer", + "default": 14400, + "minimum": 1800 + }, + "IS_K8S": { + "title": "Is k8s", + "description": "Indicates whether the instance is part of a kubernetes-based deployment.", + "type": "boolean", + "readOnly": true, + "default": false + }, + "BULK_JOB_MAX_LAUNCH": { + "title": "Max jobs to allow bulk jobs to launch", + "description": "Max jobs to allow bulk jobs to launch", + "type": "integer", + "default": 100 + }, + "BULK_HOST_MAX_CREATE": { + "title": "Max number of hosts to allow to be created in a single bulk action", + "description": "Max number of hosts to allow to be created in a single bulk action", + "type": "integer", + "default": 100 + }, + "BULK_HOST_MAX_DELETE": { + "title": "Max number of hosts to allow to be deleted in a single bulk action", + "description": "Max number of hosts to allow to be deleted in a single bulk action", + "type": "integer", + "default": 250 + }, + "SUBSCRIPTION_USAGE_MODEL": { + "title": "Defines subscription usage model and shows Host Metrics", + "type": "string", + "enum": ["", "unique_managed_hosts"], + "default": "" + }, + "CLEANUP_HOST_METRICS_LAST_TS": { + "title": "Last cleanup date for HostMetrics", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "HOST_METRIC_SUMMARY_TASK_LAST_TS": { + "title": "Last computing date of HostMetricSummaryMonthly", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "AWX_CLEANUP_PATHS": { + "title": "Enable or Disable tmp dir cleanup", + "description": "Enable or Disable TMP Dir cleanup", + "type": "boolean", + "default": true + }, + "AWX_REQUEST_PROFILE": { + "title": "Debug Web Requests", + "description": "Debug web request python timing", + "type": "boolean", + "default": false + }, + "DEFAULT_CONTAINER_RUN_OPTIONS": { + "description": "List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": ["--network", "slirp4netns:enable_ipv6=true"] + }, + "RECEPTOR_RELEASE_WORK": { + "title": "Release Receptor Work", + "description": "Release receptor work", + "type": "boolean", + "default": true + }, + "RECEPTOR_KEEP_WORK_ON_ERROR": { + "title": "Keep receptor work on error", + "description": "Prevent receptor work from being released on when error is detected", + "type": "boolean", + "default": false + }, + "SESSION_COOKIE_AGE": { + "title": "Idle Time Force Log Out", + "description": "Number of seconds that a user is inactive before they will need to login again.", + "type": "integer", + "default": 1800, + "maximum": 30000000000, + "minimum": 60 + }, + "SESSIONS_PER_USER": { + "title": "Maximum number of simultaneous logged in sessions", + "description": "Maximum number of simultaneous logged in sessions a user may have. To disable enter -1.", + "type": "integer", + "default": -1, + "minimum": -1 + }, + "DISABLE_LOCAL_AUTH": { + "title": "Disable the built-in authentication system", + "description": "Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration.", + "type": "boolean", + "default": false + }, + "AUTH_BASIC_ENABLED": { + "title": "Enable HTTP Basic Auth", + "description": "Enable HTTP Basic Auth for the API Browser.", + "type": "boolean", + "default": true + }, + "OAUTH2_PROVIDER": { + "title": "OAuth 2 Timeout Settings", + "description": "Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds.", + "type": "object", + "additionalProperties": { "type": "integer", "minimum": 1 }, + "default": { + "ACCESS_TOKEN_EXPIRE_SECONDS": 31536000000, + "AUTHORIZATION_CODE_EXPIRE_SECONDS": 600, + "REFRESH_TOKEN_EXPIRE_SECONDS": 2628000 + } + }, + "ALLOW_OAUTH2_FOR_EXTERNAL_USERS": { + "title": "Allow External Users to Create OAuth2 Tokens", + "description": "For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off.", + "type": "boolean", + "default": false + }, + "LOGIN_REDIRECT_OVERRIDE": { + "title": "Login redirect override URL", + "description": "URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page.", + "type": "string", + "default": "" + }, + "ALLOW_METRICS_FOR_ANONYMOUS_USERS": { + "title": "Allow anonymous users to poll metrics", + "description": "If true, anonymous users are allowed to poll metrics.", + "type": "boolean", + "default": false + }, + "PENDO_TRACKING_STATE": { + "title": "User Analytics Tracking State", + "description": "Enable or Disable User Analytics Tracking.", + "type": "string", + "enum": ["off", "anonymous", "detailed"], + "readOnly": true, + "default": "off" + }, + "CUSTOM_LOGIN_INFO": { + "title": "Custom Login Info", + "description": "If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported.", + "type": "string", + "default": "" + }, + "CUSTOM_LOGO": { + "title": "Custom Logo", + "description": "To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported.", + "type": "string", + "default": "" + }, + "MAX_UI_JOB_EVENTS": { + "title": "Max Job Events Retrieved by UI", + "description": "Maximum number of job events for the UI to retrieve within a single request.", + "type": "integer", + "default": 4000, + "minimum": 100 + }, + "UI_LIVE_UPDATES_ENABLED": { + "title": "Enable Live Updates in the UI", + "description": "If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details.", + "type": "boolean", + "default": true + }, + "AUTHENTICATION_BACKENDS": { + "description": "List of authentication backends that are enabled based on license features and other authentication settings.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "readOnly": true, + "default": [ + "awx.sso.backends.TACACSPlusBackend", + "awx.main.backends.AWXModelBackend" + ] + }, + "SOCIAL_AUTH_ORGANIZATION_MAP": { + "title": "Social Auth Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_TEAM_MAP": { + "title": "Social Auth Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_USER_FIELDS": { + "description": "When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "x-nullable": true + }, + "SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL": { + "title": "Use Email address for usernames", + "description": "Enabling this setting will tell social auth to use the full Email as username instead of the full name", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_1_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_1_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_1_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_1_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_1_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_1_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_1_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_1_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_1_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_1_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_1_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_1_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_1_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_1_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_1_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_1_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_2_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_2_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_2_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_2_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_2_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_2_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_2_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_2_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_2_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_2_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_2_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_2_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_2_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_2_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_2_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_2_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_3_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_3_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_3_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_3_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_3_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_3_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_3_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_3_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_3_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_3_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_3_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_3_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_3_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_3_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_3_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_3_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_4_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_4_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_4_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_4_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_4_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_4_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_4_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_4_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_4_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_4_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_4_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_4_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_4_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_4_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_4_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_4_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_5_SERVER_URI": { + "title": "LDAP Server URI", + "description": "URI to connect to LDAP server, such as \"ldap://ldap.example.com:389\" (non-SSL) or \"ldaps://ldap.example.com:636\" (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_5_BIND_DN": { + "title": "LDAP Bind DN", + "description": "DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_5_BIND_PASSWORD": { + "title": "LDAP Bind Password", + "description": "Password used to bind LDAP user account.", + "type": "string", + "default": "" + }, + "AUTH_LDAP_5_START_TLS": { + "title": "LDAP Start TLS", + "description": "Whether to enable TLS when the LDAP connection is not using SSL.", + "type": "boolean", + "default": false + }, + "AUTH_LDAP_5_CONNECTION_OPTIONS": { + "title": "LDAP Connection Options", + "description": "Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. \"OPT_REFERRALS\"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "OPT_REFERRALS": 0, "OPT_NETWORK_TIMEOUT": 30 } + }, + "AUTH_LDAP_5_USER_SEARCH": { + "description": "LDAP search query to find users. Any user that matches the given pattern will be able to login to the service. The user should also be mapped into an organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of \"LDAPUnion\" is possible. See the documentation for details.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_5_USER_DN_TEMPLATE": { + "title": "LDAP User DN Template", + "description": "Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_5_USER_ATTR_MAP": { + "title": "LDAP User Attribute Map", + "description": "Mapping of LDAP user schema to API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the documentation for additional details.", + "type": "object", + "additionalProperties": { "type": "string", "minLength": 1 }, + "default": {} + }, + "AUTH_LDAP_5_GROUP_SEARCH": { + "description": "Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "default": [] + }, + "AUTH_LDAP_5_GROUP_TYPE": { + "title": "LDAP Group Type", + "description": "The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups", + "type": "string", + "enum": [ + "PosixGroupType", + "GroupOfNamesType", + "GroupOfUniqueNamesType", + "ActiveDirectoryGroupType", + "OrganizationalRoleGroupType", + "MemberDNGroupType", + "NestedGroupOfNamesType", + "NestedGroupOfUniqueNamesType", + "NestedActiveDirectoryGroupType", + "NestedOrganizationalRoleGroupType", + "NestedMemberDNGroupType", + "PosixUIDGroupType" + ], + "default": "MemberDNGroupType" + }, + "AUTH_LDAP_5_GROUP_TYPE_PARAMS": { + "title": "LDAP Group Type Parameters", + "description": "Key value parameters to send the chosen group type init method.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "member_attr": "member", "name_attr": "cn" } + }, + "AUTH_LDAP_5_REQUIRE_GROUP": { + "title": "LDAP Require Group", + "description": "Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_5_DENY_GROUP": { + "title": "LDAP Deny Group", + "description": "Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported.", + "type": "string", + "x-nullable": true + }, + "AUTH_LDAP_5_USER_FLAGS_BY_GROUP": { + "title": "LDAP User Flags By Group", + "description": "Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string", "minLength": 1 } + }, + "default": {} + }, + "AUTH_LDAP_5_ORGANIZATION_MAP": { + "title": "LDAP Organization Map", + "description": "Mapping between organization admins/users and LDAP groups. This controls which users are placed into which organizations relative to their LDAP group memberships. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "AUTH_LDAP_5_TEAM_MAP": { + "title": "LDAP Team Map", + "description": "Mapping between team members (users) and LDAP groups. Configuration details are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "default": {} + }, + "RADIUS_SERVER": { + "title": "RADIUS Server", + "description": "Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty.", + "type": "string", + "default": "" + }, + "RADIUS_PORT": { + "title": "RADIUS Port", + "description": "Port of RADIUS server.", + "type": "integer", + "default": 1812, + "maximum": 65535, + "minimum": 1 + }, + "RADIUS_SECRET": { + "title": "RADIUS Secret", + "description": "Shared secret for authenticating to RADIUS server.", + "type": "string", + "default": "" + }, + "TACACSPLUS_HOST": { + "title": "TACACS+ Server", + "description": "Hostname of TACACS+ server.", + "type": "string", + "default": "" + }, + "TACACSPLUS_PORT": { + "title": "TACACS+ Port", + "description": "Port number of TACACS+ server.", + "type": "integer", + "default": 49, + "maximum": 65535, + "minimum": 1 + }, + "TACACSPLUS_SECRET": { + "title": "TACACS+ Secret", + "description": "Shared secret for authenticating to TACACS+ server.", + "type": "string", + "default": "" + }, + "TACACSPLUS_SESSION_TIMEOUT": { + "title": "TACACS+ Auth Session Timeout", + "description": "TACACS+ session timeout value in seconds, 0 disables timeout.", + "type": "integer", + "default": 5, + "minimum": 0 + }, + "TACACSPLUS_AUTH_PROTOCOL": { + "title": "TACACS+ Authentication Protocol", + "description": "Choose the authentication protocol used by TACACS+ client.", + "type": "string", + "enum": ["ascii", "pap"], + "default": "ascii" + }, + "TACACSPLUS_REM_ADDR": { + "title": "TACACS+ client address sending enabled", + "description": "Enable the client address sending by TACACS+ client.", + "type": "boolean", + "default": false + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL": { + "title": "Google OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/google-oauth2/", + "minLength": 1 + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_KEY": { + "title": "Google OAuth2 Key", + "description": "The OAuth2 key from your web application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET": { + "title": "Google OAuth2 Secret", + "description": "The OAuth2 secret from your web application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS": { + "description": "Update this setting to restrict the domains who are allowed to login using Google OAuth2.", + "type": "array", + "items": { "type": "string", "minLength": 1 }, + "default": [] + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS": { + "title": "Google OAuth2 Extra Arguments", + "description": "Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the documentation for more detail.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": {} + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP": { + "title": "Google OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP": { + "title": "Google OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_CALLBACK_URL": { + "title": "GitHub OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_KEY": { + "title": "GitHub OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub developer application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_SECRET": { + "title": "GitHub OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub developer application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP": { + "title": "GitHub OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_TEAM_MAP": { + "title": "GitHub OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL": { + "title": "GitHub Organization OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github-org/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_ORG_KEY": { + "title": "GitHub Organization OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ORG_SECRET": { + "title": "GitHub Organization OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ORG_NAME": { + "title": "GitHub Organization Name", + "description": "The name of your GitHub organization, as used in your organization's URL: https://github.com//.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP": { + "title": "GitHub Organization OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP": { + "title": "GitHub Organization OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL": { + "title": "GitHub Team OAuth2 Callback URL", + "description": "Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github-team/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_TEAM_KEY": { + "title": "GitHub Team OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_TEAM_SECRET": { + "title": "GitHub Team OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_TEAM_ID": { + "title": "GitHub Team ID", + "description": "Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP": { + "title": "GitHub Team OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP": { + "title": "GitHub Team OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL": { + "title": "GitHub Enterprise OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github-enterprise/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_URL": { + "title": "GitHub Enterprise URL", + "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL": { + "title": "GitHub Enterprise API URL", + "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY": { + "title": "GitHub Enterprise OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub Enterprise developer application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET": { + "title": "GitHub Enterprise OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP": { + "title": "GitHub Enterprise OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP": { + "title": "GitHub Enterprise OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL": { + "title": "GitHub Enterprise Organization OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github-enterprise-org/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL": { + "title": "GitHub Enterprise Organization URL", + "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL": { + "title": "GitHub Enterprise Organization API URL", + "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY": { + "title": "GitHub Enterprise Organization OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET": { + "title": "GitHub Enterprise Organization OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME": { + "title": "GitHub Enterprise Organization Name", + "description": "The name of your GitHub Enterprise organization, as used in your organization's URL: https://github.com//.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP": { + "title": "GitHub Enterprise Organization OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP": { + "title": "GitHub Enterprise Organization OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL": { + "title": "GitHub Enterprise Team OAuth2 Callback URL", + "description": "Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/github-enterprise-team/", + "minLength": 1 + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL": { + "title": "GitHub Enterprise Team URL", + "description": "The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL": { + "title": "GitHub Enterprise Team API URL", + "description": "The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY": { + "title": "GitHub Enterprise Team OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your GitHub Enterprise organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET": { + "title": "GitHub Enterprise Team OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID": { + "title": "GitHub Enterprise Team ID", + "description": "Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP": { + "title": "GitHub Enterprise Team OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP": { + "title": "GitHub Enterprise Team OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL": { + "title": "Azure AD OAuth2 Callback URL", + "description": "Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. ", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/azuread-oauth2/", + "minLength": 1 + }, + "SOCIAL_AUTH_AZUREAD_OAUTH2_KEY": { + "title": "Azure AD OAuth2 Key", + "description": "The OAuth2 key (Client ID) from your Azure AD application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET": { + "title": "Azure AD OAuth2 Secret", + "description": "The OAuth2 secret (Client Secret) from your Azure AD application.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP": { + "title": "Azure AD OAuth2 Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP": { + "title": "Azure AD OAuth2 Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_OIDC_KEY": { + "title": "OIDC Key", + "description": "The OIDC key (Client ID) from your IDP.", + "type": "string", + "minLength": 1 + }, + "SOCIAL_AUTH_OIDC_SECRET": { + "title": "OIDC Secret", + "description": "The OIDC secret (Client Secret) from your IDP.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_OIDC_OIDC_ENDPOINT": { + "title": "OIDC Provider URL", + "description": "The URL for your OIDC provider including the path up to /.well-known/openid-configuration", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_OIDC_VERIFY_SSL": { + "title": "Verify OIDC Provider Certificate", + "description": "Verify the OIDC provider ssl certificate.", + "type": "boolean", + "default": true + }, + "SAML_AUTO_CREATE_OBJECTS": { + "title": "Automatically Create Organizations and Teams on SAML Login", + "description": "When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login.", + "type": "boolean", + "default": true + }, + "SOCIAL_AUTH_SAML_CALLBACK_URL": { + "title": "SAML Assertion Consumer Service (ACS) URL", + "description": "Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/complete/saml/", + "minLength": 1 + }, + "SOCIAL_AUTH_SAML_METADATA_URL": { + "title": "SAML Service Provider Metadata URL", + "description": "If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL.", + "type": "string", + "readOnly": true, + "default": "https://platformhost/sso/metadata/saml/", + "minLength": 1 + }, + "SOCIAL_AUTH_SAML_SP_ENTITY_ID": { + "title": "SAML Service Provider Entity ID", + "description": "The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_SAML_SP_PUBLIC_CERT": { + "title": "SAML Service Provider Public Certificate", + "description": "Create a keypair to use as a service provider (SP) and include the certificate content here.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_SAML_SP_PRIVATE_KEY": { + "title": "SAML Service Provider Private Key", + "description": "Create a keypair to use as a service provider (SP) and include the private key content here.", + "type": "string", + "default": "" + }, + "SOCIAL_AUTH_SAML_ORG_INFO": { + "title": "SAML Service Provider Organization Info", + "description": "Provide the URL, display name, and the name of your app. Refer to the documentation for example syntax.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true } + }, + "default": {} + }, + "SOCIAL_AUTH_SAML_TECHNICAL_CONTACT": { + "title": "SAML Service Provider Technical Contact", + "description": "Provide the name and email address of the technical contact for your service provider. Refer to the documentation for example syntax.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": {} + }, + "SOCIAL_AUTH_SAML_SUPPORT_CONTACT": { + "title": "SAML Service Provider Support Contact", + "description": "Provide the name and email address of the support contact for your service provider. Refer to the documentation for example syntax.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": {} + }, + "SOCIAL_AUTH_SAML_ENABLED_IDPS": { + "title": "SAML Enabled Identity Providers", + "description": "Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true } + }, + "default": {} + }, + "SOCIAL_AUTH_SAML_SECURITY_CONFIG": { + "title": "SAML Security Config", + "description": "A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "default": { "requestedAuthnContext": false }, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_SP_EXTRA": { + "title": "SAML Service Provider extra configuration data", + "description": "A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_EXTRA_DATA": { + "description": "A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value.", + "type": "array", + "items": { "type": "string", "x-nullable": true }, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_ORGANIZATION_MAP": { + "title": "SAML Organization Map", + "description": "Mapping to organization admins/users from social auth accounts. This setting\ncontrols which users are placed into which organizations based on their\nusername and email address. Configuration details are available in the\ndocumentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_TEAM_MAP": { + "title": "SAML Team Map", + "description": "Mapping of team members (users) from social auth accounts. Configuration\ndetails are available in the documentation.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { "type": "string" } + }, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_ORGANIZATION_ATTR": { + "title": "SAML Organization Attribute Mapping", + "description": "Used to translate user organization membership.", + "type": "object", + "additionalProperties": { "type": "string" }, + "default": {}, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_TEAM_ATTR": { + "title": "SAML Team Attribute Mapping", + "description": "Used to translate user team membership.", + "type": "object", + "additionalProperties": { "type": "string" }, + "default": {}, + "x-nullable": true + }, + "SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR": { + "title": "SAML User Flags Attribute Mapping", + "description": "Used to map super users and system auditors from SAML.", + "type": "object", + "additionalProperties": { "type": "string" }, + "default": {}, + "x-nullable": true + }, + "LOCAL_PASSWORD_MIN_LENGTH": { + "title": "Minimum number of characters in local password", + "description": "Minimum number of characters required in a local password. 0 means no minimum", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "LOCAL_PASSWORD_MIN_DIGITS": { + "title": "Minimum number of digit characters in local password", + "description": "Minimum number of digit characters required in a local password. 0 means no minimum", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "LOCAL_PASSWORD_MIN_UPPER": { + "title": "Minimum number of uppercase characters in local password", + "description": "Minimum number of uppercase characters required in a local password. 0 means no minimum", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "LOCAL_PASSWORD_MIN_SPECIAL": { + "title": "Minimum number of special characters in local password", + "description": "Minimum number of special characters required in a local password. 0 means no minimum", + "type": "integer", + "default": 0, + "minimum": 0 + }, + "NAMED_URL_FORMATS": { + "title": "Formats of all available named urls", + "description": "Read-only list of key-value pairs that shows the standard format of all available named URLs.", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "readOnly": true, + "default": { + "execution_environments": "", + "organizations": "", + "teams": "++", + "credential_types": "+", + "credentials": "+++++", + "notification_templates": "++", + "job_templates": "++", + "projects": "++", + "inventories": "++", + "hosts": "++++", + "groups": "++++", + "inventory_sources": "++++", + "instance_groups": "", + "workflow_job_templates": "++", + "workflow_job_template_nodes": "++++", + "labels": "++", + "applications": "++", + "users": "", + "instances": "" + } + }, + "NAMED_URL_GRAPH_NODES": { + "title": "List of all named url graph nodes.", + "description": "Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources", + "type": "object", + "additionalProperties": { "type": "string", "x-nullable": true }, + "readOnly": true, + "default": { + "execution_environments": { "fields": ["name"], "adj_list": [] }, + "organizations": { "fields": ["name"], "adj_list": [] }, + "teams": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "credential_types": { "fields": ["name", "kind"], "adj_list": [] }, + "credentials": { + "fields": ["name"], + "adj_list": [ + ["credential_type", "credential_types"], + ["organization", "organizations"] + ] + }, + "notification_templates": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "job_templates": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "projects": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "inventories": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "hosts": { + "fields": ["name"], + "adj_list": [["inventory", "inventories"]] + }, + "groups": { + "fields": ["name"], + "adj_list": [["inventory", "inventories"]] + }, + "inventory_sources": { + "fields": ["name"], + "adj_list": [["inventory", "inventories"]] + }, + "instance_groups": { "fields": ["name"], "adj_list": [] }, + "workflow_job_templates": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "workflow_job_template_nodes": { + "fields": ["identifier"], + "adj_list": [["workflow_job_template", "workflow_job_templates"]] + }, + "labels": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "applications": { + "fields": ["name"], + "adj_list": [["organization", "organizations"]] + }, + "users": { "fields": ["username"], "adj_list": [] }, + "instances": { "fields": ["hostname"], "adj_list": [] } + } + } + } + }, + "SystemJobTemplate": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "ok", + "missing", + "none", + "updating" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": [ + "cleanup_jobs", + "cleanup_activitystream", + "cleanup_sessions", + "cleanup_tokens" + ], + "default": "", + "x-nullable": true + } + } + }, + "SystemJobList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "system_job_template": { + "title": "System job template", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": [ + "cleanup_jobs", + "cleanup_activitystream", + "cleanup_sessions", + "cleanup_tokens" + ], + "default": "", + "x-nullable": true + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "result_stdout": { + "title": "Result stdout", + "type": "string", + "readOnly": true + } + } + }, + "SystemJob": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "execution_node": { + "title": "Execution node", + "description": "The node the job executed on.", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "system_job_template": { + "title": "System job template", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": [ + "cleanup_jobs", + "cleanup_activitystream", + "cleanup_sessions", + "cleanup_tokens" + ], + "default": "", + "x-nullable": true + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "result_stdout": { + "title": "Result stdout", + "type": "string", + "readOnly": true + } + } + }, + "SystemJobCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + }, + "SystemJobEvent": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "event": { "title": "Event", "type": "string", "readOnly": true }, + "counter": { + "title": "Counter", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "event_display": { + "title": "Event display", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_data": { + "title": "Event data", + "type": "object", + "default": {} + }, + "failed": { "title": "Failed", "type": "string", "readOnly": true }, + "changed": { "title": "Changed", "type": "string", "readOnly": true }, + "uuid": { + "title": "Uuid", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "stdout": { + "title": "Stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "start_line": { + "title": "Start line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "end_line": { + "title": "End line", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "verbosity": { + "title": "Verbosity", + "type": "integer", + "readOnly": true, + "minimum": 0 + }, + "system_job": { + "title": "System job", + "type": "string", + "readOnly": true + } + } + }, + "TeamCredentialSerializerCreate": { + "required": ["name", "credential_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "credential_type": { + "title": "Credential Type", + "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", + "type": "integer" + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "kind": { "title": "Kind", "type": "string", "readOnly": true }, + "cloud": { "title": "Cloud", "type": "string", "readOnly": true }, + "kubernetes": { + "title": "Kubernetes", + "type": "string", + "readOnly": true + }, + "team": { + "title": "Team", + "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation.", + "type": "integer", + "x-nullable": true + } + } + }, + "RoleSerializerWithParentAccess": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "name": { "title": "Name", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "readOnly": true + } + } + }, + "OAuth2TokenDetail": { + "type": "object", + "properties": { + "id": { "title": "Id", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "user": { + "title": "User", + "description": "The user representing the token owner", + "type": "integer", + "readOnly": true + }, + "token": { "title": "Token", "type": "string", "readOnly": true }, + "refresh_token": { + "title": "Refresh token", + "type": "string", + "readOnly": true + }, + "application": { + "title": "Application", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "expires": { + "title": "Expires", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "title": "Scope", + "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", + "type": "string", + "default": "write", + "x-nullable": true + } + } + }, + "UserAuthorizedToken": { + "required": ["application"], + "type": "object", + "properties": { + "id": { "title": "Id", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "user": { + "title": "User", + "description": "The user representing the token owner", + "type": "integer", + "readOnly": true + }, + "token": { "title": "Token", "type": "string", "readOnly": true }, + "refresh_token": { + "title": "Refresh token", + "type": "string", + "readOnly": true + }, + "application": { "title": "Application", "type": "integer" }, + "expires": { + "title": "Expires", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "title": "Scope", + "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", + "type": "string", + "default": "write", + "x-nullable": true + } + } + }, + "UserCredentialSerializerCreate": { + "required": ["name", "credential_type"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "credential_type": { + "title": "Credential Type", + "description": "Specify the type of credential you want to create. Refer to the documentation for details on each type.", + "type": "integer" + }, + "managed": { "title": "Managed", "type": "string", "readOnly": true }, + "inputs": { + "title": "Inputs", + "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.", + "type": "object", + "default": {} + }, + "kind": { "title": "Kind", "type": "string", "readOnly": true }, + "cloud": { "title": "Cloud", "type": "string", "readOnly": true }, + "kubernetes": { + "title": "Kubernetes", + "type": "string", + "readOnly": true + }, + "user": { + "title": "User", + "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation.", + "type": "integer", + "x-nullable": true + } + } + }, + "UserPersonalToken": { + "type": "object", + "properties": { + "id": { "title": "Id", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "user": { + "title": "User", + "description": "The user representing the token owner", + "type": "integer", + "readOnly": true + }, + "token": { "title": "Token", "type": "string", "readOnly": true }, + "refresh_token": { + "title": "Refresh token", + "type": "string", + "readOnly": true + }, + "application": { + "title": "Application", + "type": "integer", + "readOnly": true, + "x-nullable": true + }, + "expires": { + "title": "Expires", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "title": "Scope", + "description": "Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].", + "type": "string", + "default": "write", + "x-nullable": true + } + } + }, + "WorkflowApprovalTemplate": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "last_job_run": { + "title": "Last job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "last_job_failed": { + "title": "Last job failed", + "type": "boolean", + "readOnly": true + }, + "next_job_run": { + "title": "Next job run", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled", + "never updated", + "ok", + "missing", + "none", + "updating" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) before the approval node expires and fails.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + } + } + }, + "WorkflowApprovalList": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "can_approve_or_deny": { + "title": "Can approve or deny", + "type": "string", + "readOnly": true + }, + "approval_expiration": { + "title": "Approval expiration", + "type": "string", + "readOnly": true + }, + "timed_out": { + "title": "Timed out", + "type": "string", + "readOnly": true + } + } + }, + "WorkflowApproval": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "event_processing_finished": { + "title": "Event processing finished", + "description": "Indicates whether all of the events generated by this unified job have been saved to the database.", + "type": "boolean", + "readOnly": true + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "can_approve_or_deny": { + "title": "Can approve or deny", + "type": "string", + "readOnly": true + }, + "approval_expiration": { + "title": "Approval expiration", + "type": "string", + "readOnly": true + }, + "timed_out": { + "title": "Timed out", + "type": "string", + "readOnly": true + } + } + }, + "WorkflowApprovalView": { "type": "object", "properties": {} }, + "WorkflowJobNodeList": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "job": { "title": "Job", "type": "integer", "x-nullable": true }, + "workflow_job": { + "title": "Workflow job", + "type": "string", + "x-nullable": true + }, + "unified_job_template": { + "title": "Unified job template", + "type": "integer", + "x-nullable": true + }, + "success_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "failure_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "always_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "all_parents_must_converge": { + "title": "All parents must converge", + "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "do_not_run": { + "title": "Do not run", + "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "identifier": { + "title": "Identifier", + "description": "An identifier coresponding to the workflow job template node that this node was created from.", + "type": "string", + "maxLength": 512, + "x-nullable": true + } + } + }, + "WorkflowJobNodeDetail": { + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "job": { "title": "Job", "type": "integer", "x-nullable": true }, + "workflow_job": { + "title": "Workflow job", + "type": "string", + "x-nullable": true + }, + "unified_job_template": { + "title": "Unified job template", + "type": "integer", + "x-nullable": true + }, + "success_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "failure_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "always_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "all_parents_must_converge": { + "title": "All parents must converge", + "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "do_not_run": { + "title": "Do not run", + "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "identifier": { + "title": "Identifier", + "description": "An identifier coresponding to the workflow job template node that this node was created from.", + "type": "string", + "maxLength": 512, + "x-nullable": true + } + } + }, + "WorkflowJobTemplateNode": { + "required": ["workflow_job_template"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "workflow_job_template": { + "title": "Workflow job template", + "type": "string" + }, + "unified_job_template": { + "title": "Unified job template", + "type": "integer", + "x-nullable": true + }, + "success_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "failure_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "always_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "all_parents_must_converge": { + "title": "All parents must converge", + "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "identifier": { + "title": "Identifier", + "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", + "type": "string", + "default": "eeec4864-6365-41f1-b4f4-a7e1f814d212", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + } + } + }, + "WorkflowJobTemplateNodeDetail": { + "required": ["workflow_job_template"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "extra_data": { + "title": "Extra data", + "type": "object", + "default": {} + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "job_type": { + "title": "Job type", + "type": "string", + "enum": ["run", "check"], + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "diff_mode": { + "title": "Diff mode", + "type": "boolean", + "x-nullable": true + }, + "verbosity": { + "title": "Verbosity", + "type": "string", + "enum": [0, 1, 2, 3, 4, 5], + "x-nullable": true + }, + "execution_environment": { + "title": "Execution environment", + "description": "The container image to be used for execution.", + "type": "integer", + "x-nullable": true + }, + "forks": { + "title": "Forks", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "job_slice_count": { + "title": "Job slice count", + "type": "integer", + "minimum": 0, + "x-nullable": true + }, + "timeout": { + "title": "Timeout", + "type": "integer", + "x-nullable": true + }, + "workflow_job_template": { + "title": "Workflow job template", + "type": "string" + }, + "unified_job_template": { + "title": "Unified job template", + "type": "integer", + "x-nullable": true + }, + "success_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "failure_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "always_nodes": { + "type": "array", + "items": { "type": "integer" }, + "readOnly": true, + "uniqueItems": true + }, + "all_parents_must_converge": { + "title": "All parents must converge", + "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "identifier": { + "title": "Identifier", + "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", + "type": "string", + "default": "8feeb898-637c-4014-9933-28441332f023", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + } + } + }, + "WorkflowJobTemplateNodeCreateApproval": { + "required": ["name"], + "type": "object", + "properties": { + "timeout": { + "title": "Timeout", + "description": "The amount of time (in seconds) before the approval node expires and fails.", + "type": "integer", + "default": 0, + "maximum": 2147483647, + "minimum": -2147483648 + }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + } + } + }, + "WorkflowJobLaunch": { + "type": "object", + "properties": { + "ask_inventory_on_launch": { + "title": "Ask inventory on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_limit_on_launch": { + "title": "Ask limit on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_scm_branch_on_launch": { + "title": "Ask scm branch on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "can_start_without_user_input": { + "title": "Can start without user input", + "type": "boolean", + "readOnly": true + }, + "defaults": { "title": "Defaults", "type": "string", "readOnly": true }, + "extra_vars": { "title": "Extra vars", "type": "string" }, + "inventory": { "title": "Inventory", "type": "integer" }, + "limit": { "title": "Limit", "type": "string" }, + "scm_branch": { "title": "Scm branch", "type": "string" }, + "survey_enabled": { + "title": "Survey enabled", + "type": "string", + "readOnly": true + }, + "variables_needed_to_start": { + "title": "Variables needed to start", + "type": "string", + "readOnly": true + }, + "node_templates_missing": { + "title": "Node templates missing", + "type": "string", + "readOnly": true + }, + "node_prompts_rejected": { + "title": "Node prompts rejected", + "type": "string", + "readOnly": true + }, + "workflow_job_template_data": { + "title": "Workflow job template data", + "type": "string", + "readOnly": true + }, + "ask_variables_on_launch": { + "title": "Ask variables on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_labels_on_launch": { + "title": "Ask labels on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "labels": { + "type": "array", + "items": { "type": "integer" }, + "uniqueItems": true + }, + "ask_skip_tags_on_launch": { + "title": "Ask skip tags on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "ask_tags_on_launch": { + "title": "Ask tags on launch", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "skip_tags": { "title": "Skip tags", "type": "string" }, + "job_tags": { "title": "Job tags", "type": "string" } + } + }, + "WorkflowJob": { + "required": ["name"], + "type": "object", + "properties": { + "id": { "title": "ID", "type": "integer", "readOnly": true }, + "type": { "title": "Type", "type": "string", "readOnly": true }, + "url": { "title": "Url", "type": "string", "readOnly": true }, + "related": { "title": "Related", "type": "string", "readOnly": true }, + "summary_fields": { + "title": "Summary fields", + "type": "string", + "readOnly": true + }, + "created": { "title": "Created", "type": "string", "readOnly": true }, + "modified": { "title": "Modified", "type": "string", "readOnly": true }, + "name": { + "title": "Name", + "type": "string", + "maxLength": 512, + "minLength": 1, + "x-nullable": true + }, + "description": { + "title": "Description", + "type": "string", + "default": "", + "x-nullable": true + }, + "unified_job_template": { + "title": "unified job template", + "type": "string", + "readOnly": true + }, + "launch_type": { + "title": "Launch type", + "type": "string", + "enum": [ + "manual", + "relaunch", + "callback", + "scheduled", + "dependency", + "workflow", + "webhook", + "sync", + "scm" + ], + "readOnly": true + }, + "status": { + "title": "Status", + "type": "string", + "enum": [ + "new", + "pending", + "waiting", + "running", + "successful", + "failed", + "error", + "canceled" + ], + "readOnly": true + }, + "failed": { "title": "Failed", "type": "boolean", "readOnly": true }, + "started": { + "title": "Started", + "description": "The date and time the job was queued for starting.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "finished": { + "title": "Finished", + "description": "The date and time the job finished execution.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "canceled_on": { + "title": "Canceled on", + "description": "The date and time when the cancel request was sent.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "elapsed": { + "title": "Elapsed", + "description": "Elapsed time in seconds that the job ran.", + "type": "string", + "format": "decimal", + "readOnly": true + }, + "job_args": { + "title": "Job args", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_cwd": { + "title": "Job cwd", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "job_env": { "title": "job_env", "type": "object", "readOnly": true }, + "job_explanation": { + "title": "Job explanation", + "description": "A status field to indicate the state of the job if it wasn't able to run and capture stdout", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "result_traceback": { + "title": "Result traceback", + "type": "string", + "readOnly": true, + "minLength": 1 + }, + "launched_by": { + "title": "Launched by", + "type": "string", + "readOnly": true + }, + "work_unit_id": { + "title": "Work unit id", + "description": "The Receptor work unit ID associated with this job.", + "type": "string", + "readOnly": true, + "minLength": 1, + "x-nullable": true + }, + "workflow_job_template": { + "title": "Workflow job template", + "type": "string", + "x-nullable": true + }, + "extra_vars": { + "title": "Extra vars", + "type": "string", + "default": "", + "x-nullable": true + }, + "allow_simultaneous": { + "title": "Allow simultaneous", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "job_template": { + "title": "Job template", + "description": "If automatically created for a sliced job run, the job template the workflow job was created from.", + "type": "string", + "x-nullable": true + }, + "is_sliced_job": { + "title": "Is sliced job", + "type": "boolean", + "default": false, + "x-nullable": true + }, + "inventory": { + "title": "Inventory", + "description": "Inventory applied as a prompt, assuming job template prompts for inventory", + "type": "integer", + "x-nullable": true + }, + "limit": { "title": "Limit", "type": "string", "x-nullable": true }, + "scm_branch": { + "title": "Scm branch", + "type": "string", + "x-nullable": true + }, + "webhook_service": { + "title": "Webhook service", + "description": "Service that webhook requests will be accepted from", + "type": "string", + "enum": ["github", "gitlab", "bitbucket_dc"], + "x-nullable": true + }, + "webhook_credential": { + "title": "Webhook credential", + "description": "Personal Access Token for posting back the status to the service API", + "type": "integer", + "x-nullable": true + }, + "webhook_guid": { + "title": "Webhook guid", + "description": "Unique identifier of the event that triggered this webhook", + "type": "string", + "maxLength": 128, + "x-nullable": true + }, + "skip_tags": { + "title": "Skip tags", + "type": "string", + "x-nullable": true + }, + "job_tags": { + "title": "Job tags", + "type": "string", + "x-nullable": true + } + } + }, + "WorkflowJobCancel": { + "type": "object", + "properties": { + "can_cancel": { + "title": "Can cancel", + "type": "boolean", + "readOnly": true + } + } + } + } +} diff --git a/test/ApiApi.test.ts b/test/ApiApi.test.ts index c042eb2..791f69e 100644 --- a/test/ApiApi.test.ts +++ b/test/ApiApi.test.ts @@ -1,12 +1,11 @@ import { ApiApi } from "awx-api-client"; import { configuration } from "./Config"; -describe("AWXApiTest", () => { +describe("AWX API Test", () => { const api = new ApiApi(configuration); test("api list", async () => { const response = await api.apiList(); - console.log(response); expect(response).toEqual({ description: "AWX REST API", current_version: "/api/v2/", From b49749be7a4ab1c5dddd0db9c7ead6fefa9049fc Mon Sep 17 00:00:00 2001 From: ryan-bennett Date: Fri, 11 Oct 2024 13:04:01 +1000 Subject: [PATCH 9/9] Generate command --- generate.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate.js b/generate.js index 3f88bd4..6f32107 100644 --- a/generate.js +++ b/generate.js @@ -1,3 +1,3 @@ const {execSync} = require('child_process'); -execSync(`docker run --rm -v "${process.cwd()}:/local\" openapitools/openapi-generator-cli:v7.9.0 generate -i /local/spec.json -g typescript-fetch -o /local/generated -p debugOpenAPI=true -p verbose=false -p supportsES6=false -p npmName=awx-api-client -p npmVersion=1.0.0`); \ No newline at end of file +execSync(`docker run --rm -v "${process.cwd()}:/local\" openapitools/openapi-generator-cli:v7.9.0 generate -i /local/spec.json -g typescript-fetch -o /local/generated -p supportsES6=true -p npmName=awx-api-client -p npmVersion=1.0.0`); \ No newline at end of file