You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by zr...@apache.org on 2021/07/14 21:45:52 UTC
[trafficcontrol] branch master updated: Remove api v1 (#5539)
This is an automated email from the ASF dual-hosted git repository.
zrhoffman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 20ba2bc Remove api v1 (#5539)
20ba2bc is described below
commit 20ba2bc3de18ee10bb00cf836d1796d220264281
Author: ocket8888 <oc...@apache.org>
AuthorDate: Wed Jul 14 15:45:37 2021 -0600
Remove api v1 (#5539)
* Remove APIv1
* Remove APIv1 docs
* Remove APIv1 client/TO integration tests
* Remove APIv1 tests from CI
* Update CHANGELOG
* Remove API v1 from Docker integration tests
* Removed double init and enroll
* Add v4 docs to toctree
* Fix v3 Delivery Services API returning v2 representations
* Remove APIv1 migration section
* Fix segfaults in APIv2 tests
* Correct lingering incorrect references to API v1 in GoDoc comments in TO
* Fix hard-coded header API version
* Update API version used by copy-pgdata.sh
* Update API version used in logout test
* Remove 'legacy' API version from TP
* Remove lingering references to APIv1 in examples and comments
* Remove defunct TO-generated-configuration-file comparison tool
* Remove TR tests for APIv1.x
* Remove documentation linking to removed APIv1 client
* Rename handler whose name implied it's for a removed API version
---
.github/workflows/traffic-ops.yml | 18 -
CHANGELOG.md | 2 +
cache-config/t3cutil/getdata.go | 20 +-
docs/source/api/index.rst | 78 +-
docs/source/api/migrating-from-v1.rst | 668 -----
docs/source/api/v1/api_capabilities.rst | 184 --
docs/source/api/v1/api_capabilities_id.rst | 262 --
docs/source/api/v1/asns.rst | 173 --
docs/source/api/v1/asns_id.rst | 224 --
docs/source/api/v1/cache_stats.rst | 171 --
docs/source/api/v1/cachegroup_fallbacks.rst | 303 ---
.../api/v1/cachegroup_parameterID_parameter.rst | 115 -
docs/source/api/v1/cachegroupparameters.rst | 186 --
.../api/v1/cachegroupparameters_id_parameterID.rst | 75 -
docs/source/api/v1/cachegroups.rst | 265 --
docs/source/api/v1/cachegroups_id.rst | 326 ---
.../api/v1/cachegroups_id_deliveryservices.rst | 93 -
docs/source/api/v1/cachegroups_id_parameters.rst | 97 -
docs/source/api/v1/cachegroups_id_queue_update.rst | 91 -
.../v1/cachegroups_id_unassigned_parameters.rst | 115 -
...cachegroups_parameterID_parameter_available.rst | 66 -
docs/source/api/v1/cachegroups_trimmed.rst | 87 -
docs/source/api/v1/caches_stats.rst | 80 -
docs/source/api/v1/capabilities.rst | 158 --
docs/source/api/v1/capabilities_name.rst | 230 --
docs/source/api/v1/cdns.rst | 165 --
docs/source/api/v1/cdns_capacity.rst | 51 -
docs/source/api/v1/cdns_configs.rst | 71 -
docs/source/api/v1/cdns_dnsseckeys_refresh.rst | 55 -
docs/source/api/v1/cdns_domains.rst | 53 -
docs/source/api/v1/cdns_health.rst | 59 -
docs/source/api/v1/cdns_id.rst | 195 --
docs/source/api/v1/cdns_id_queue_update.rst | 78 -
docs/source/api/v1/cdns_id_snapshot.rst | 79 -
..._types_metric_start_date_start_end_date_end.rst | 95 -
.../source/api/v1/cdns_name_configs_monitoring.rst | 231 --
docs/source/api/v1/cdns_name_configs_routing.rst | 309 ---
.../api/v1/cdns_name_dnsseckeys_ksk_generate.rst | 50 -
docs/source/api/v1/cdns_name_federations.rst | 195 --
docs/source/api/v1/cdns_name_federations_id.rst | 260 --
docs/source/api/v1/cdns_name_health.rst | 89 -
docs/source/api/v1/cdns_name_name.rst | 122 -
docs/source/api/v1/cdns_name_name_dnsseckeys.rst | 115 -
.../api/v1/cdns_name_name_dnsseckeys_delete.rst | 55 -
docs/source/api/v1/cdns_name_name_sslkeys.rst | 67 -
docs/source/api/v1/cdns_name_snapshot.rst | 553 ----
docs/source/api/v1/cdns_name_snapshot_new.rst | 556 ----
docs/source/api/v1/cdns_routing.rst | 75 -
docs/source/api/v1/cdns_usage_overview.rst | 66 -
docs/source/api/v1/consistenthash.rst | 75 -
docs/source/api/v1/coordinates.rst | 308 ---
docs/source/api/v1/current_stats.rst | 92 -
docs/source/api/v1/dbdump.rst | 66 -
.../v1/deliveryservice_server_dsid_serverid.rst | 74 -
docs/source/api/v1/deliveryservice_stats.rst | 204 --
docs/source/api/v1/deliveryservice_user.rst | 88 -
.../api/v1/deliveryservice_user_dsid_userid.rst | 71 -
docs/source/api/v1/deliveryservices.rst | 625 -----
.../v1/deliveryservices_dnsseckeys_generate.rst | 51 -
.../v1/deliveryservices_hostname_name_sslkeys.rst | 118 -
docs/source/api/v1/deliveryservices_id.rst | 508 ----
.../source/api/v1/deliveryservices_id_capacity.rst | 73 -
docs/source/api/v1/deliveryservices_id_health.rst | 83 -
docs/source/api/v1/deliveryservices_id_regexes.rst | 178 --
.../api/v1/deliveryservices_id_regexes_rid.rst | 230 --
docs/source/api/v1/deliveryservices_id_routing.rst | 97 -
docs/source/api/v1/deliveryservices_id_safe.rst | 274 --
docs/source/api/v1/deliveryservices_id_servers.rst | 154 --
.../v1/deliveryservices_id_servers_eligible.rst | 146 --
docs/source/api/v1/deliveryservices_id_state.rst | 90 -
.../v1/deliveryservices_id_unassigned_servers.rst | 140 --
docs/source/api/v1/deliveryservices_regexes.rst | 72 -
docs/source/api/v1/deliveryservices_request.rst | 135 -
.../v1/deliveryservices_required_capabilities.rst | 226 --
.../source/api/v1/deliveryservices_sslkeys_add.rst | 71 -
.../api/v1/deliveryservices_sslkeys_generate.rst | 69 -
...liveryservices_sslkeys_generate_letsencrypt.rst | 68 -
.../api/v1/deliveryservices_xmlid_servers.rst | 82 -
.../api/v1/deliveryservices_xmlid_urisignkeys.rst | 194 --
.../v1/deliveryservices_xmlid_xmlid_sslkeys.rst | 104 -
...deliveryservices_xmlid_xmlid_sslkeys_delete.rst | 74 -
.../v1/deliveryservices_xmlid_xmlid_urlkeys.rst | 68 -
...d_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst | 49 -
...liveryservices_xmlid_xmlid_urlkeys_generate.rst | 49 -
docs/source/api/v1/deliveryserviceserver.rst | 161 --
docs/source/api/v1/divisions.rst | 146 --
docs/source/api/v1/divisions_id.rst | 168 --
docs/source/api/v1/divisions_name_regions.rst | 93 -
docs/source/api/v1/federation_resolvers.rst | 238 --
docs/source/api/v1/federation_resolvers_id.rst | 94 -
docs/source/api/v1/federations.rst | 292 ---
.../api/v1/federations_id_deliveryservices.rst | 173 --
.../api/v1/federations_id_deliveryservices_id.rst | 75 -
.../api/v1/federations_id_federation_resolvers.rst | 157 --
docs/source/api/v1/federations_id_users.rst | 164 --
docs/source/api/v1/federations_id_users_id.rst | 75 -
docs/source/api/v1/hwinfo.rst | 116 -
docs/source/api/v1/isos.rst | 128 -
docs/source/api/v1/jobs.rst | 392 ---
docs/source/api/v1/jobs_id.rst | 97 -
docs/source/api/v1/keys_ping.rst | 73 -
docs/source/api/v1/letsencrypt_autorenew.rst | 55 -
docs/source/api/v1/letsencrypt_dnsrecords.rst | 68 -
docs/source/api/v1/logs.rst | 114 -
docs/source/api/v1/logs_days_days.rst | 111 -
docs/source/api/v1/logs_newcount.rst | 60 -
docs/source/api/v1/origins.rst | 422 ----
docs/source/api/v1/osversions.rst | 82 -
docs/source/api/v1/parameterprofile.rst | 86 -
docs/source/api/v1/parameters.rst | 209 --
docs/source/api/v1/parameters_id.rst | 246 --
docs/source/api/v1/parameters_id_profiles.rst | 91 -
.../api/v1/parameters_id_unassigned_profiles.rst | 106 -
docs/source/api/v1/parameters_profile_name.rst | 115 -
docs/source/api/v1/parameters_validate.rst | 127 -
docs/source/api/v1/phys_locations.rst | 220 --
docs/source/api/v1/phys_locations_id.rst | 290 ---
docs/source/api/v1/phys_locations_trimmed.rst | 68 -
docs/source/api/v1/profileparameter.rst | 87 -
docs/source/api/v1/profileparameters.rst | 186 --
.../v1/profileparameters_profileID_parameterID.rst | 73 -
docs/source/api/v1/profiles.rst | 168 --
docs/source/api/v1/profiles_id.rst | 264 --
docs/source/api/v1/profiles_id_export.rst | 97 -
docs/source/api/v1/profiles_id_parameters.rst | 242 --
.../api/v1/profiles_id_unassigned_parameters.rst | 100 -
docs/source/api/v1/profiles_import.rst | 114 -
.../source/api/v1/profiles_name_name_copy_copy.rst | 88 -
.../api/v1/profiles_name_name_parameters.rst | 246 --
docs/source/api/v1/profiles_trimmed.rst | 74 -
docs/source/api/v1/regions.rst | 227 --
docs/source/api/v1/regions_id.rst | 176 --
docs/source/api/v1/regions_name_phys_locations.rst | 131 -
.../api/v1/riak_bucket_bucket_key_key_values.rst | 91 -
docs/source/api/v1/riak_ping.rst | 65 -
docs/source/api/v1/roles.rst | 319 ---
docs/source/api/v1/server_capabilities.rst | 191 --
docs/source/api/v1/server_server_capabilities.rst | 227 --
docs/source/api/v1/servercheck.rst | 72 -
docs/source/api/v1/servers.rst | 412 ---
docs/source/api/v1/servers_checks.rst | 94 -
.../api/v1/servers_hostname_name_details.rst | 149 --
.../api/v1/servers_hostname_update_status.rst | 96 -
docs/source/api/v1/servers_id.rst | 477 ----
docs/source/api/v1/servers_id_deliveryservices.rst | 276 --
docs/source/api/v1/servers_id_queue_update.rst | 96 -
docs/source/api/v1/servers_id_status.rst | 83 -
docs/source/api/v1/servers_status.rst | 74 -
docs/source/api/v1/servers_totals.rst | 103 -
docs/source/api/v1/snapshot_name.rst | 80 -
docs/source/api/v1/staticdnsentries.rst | 376 ---
docs/source/api/v1/stats_summary.rst | 251 --
docs/source/api/v1/statuses.rst | 96 -
docs/source/api/v1/statuses_id.rst | 106 -
docs/source/api/v1/steering_id_targets.rst | 184 --
.../source/api/v1/steering_id_targets_targetID.rst | 237 --
docs/source/api/v1/system_info.rst | 88 -
docs/source/api/v1/tenants.rst | 167 --
docs/source/api/v1/tenants_id.rst | 215 --
docs/source/api/v1/to_extensions.rst | 241 --
docs/source/api/v1/to_extensions_id_delete.rst | 81 -
docs/source/api/v1/traffic_monitor_stats.rst | 72 -
docs/source/api/v1/types.rst | 84 -
docs/source/api/v1/types_id.rst | 221 --
docs/source/api/v1/types_trimmed.rst | 209 --
docs/source/api/v1/user_current.rst | 249 --
docs/source/api/v1/user_current_jobs.rst | 214 --
docs/source/api/v1/user_current_update.rst | 115 -
.../api/v1/user_id_deliveryservices_available.rst | 85 -
docs/source/api/v1/user_login.rst | 73 -
docs/source/api/v1/user_login_oauth.rst | 78 -
docs/source/api/v1/user_login_token.rst | 73 -
docs/source/api/v1/user_logout.rst | 58 -
docs/source/api/v1/user_reset_password.rst | 73 -
docs/source/api/v1/users.rst | 273 --
docs/source/api/v1/users_id.rst | 257 --
docs/source/api/v1/users_id_deliveryservices.rst | 251 --
docs/source/api/v1/users_register.rst | 95 -
docs/source/development/debugging.rst | 2 +-
grove/grovetccfg/grovetccfg.go | 1 -
infrastructure/cdn-in-a-box/traffic_ops/run-go.sh | 5 -
.../traffic_ops_integration_test/Dockerfile | 5 +-
lib/go-tc/deliveryservices.go | 7 -
lib/go-tc/federation.go | 10 +-
lib/go-tc/servers.go | 2 +-
lib/go-tc/traffic_stats.go | 16 -
test/traffic_ops_cfg/Readme.md | 36 -
test/traffic_ops_cfg/cfg_test.pl | 432 ----
test/traffic_ops_cfg/test.config | 7 -
traffic_control/clients/README.md | 11 +-
.../clients/python/trafficops/restapi.py | 4 +-
.../clients/python/trafficops/tosession.py | 4 +-
traffic_ops/install/bin/copy-pgdata.sh | 6 +-
traffic_ops/testing/api/v1/.gitignore | 19 -
traffic_ops/testing/api/v1/about_test.go | 33 -
traffic_ops/testing/api/v1/api_capability_test.go | 77 -
.../testing/api/v1/cachegroups_parameters_test.go | 174 --
traffic_ops/testing/api/v1/cachegroups_test.go | 315 ---
.../api/v1/cachegroupsdeliveryservices_test.go | 171 --
traffic_ops/testing/api/v1/capabilities_test.go | 117 -
traffic_ops/testing/api/v1/cdn_domains_test.go | 34 -
traffic_ops/testing/api/v1/cdnfederations_test.go | 243 --
traffic_ops/testing/api/v1/cdns_test.go | 108 -
.../testing/api/v1/config/cachecfg/cachecfg.go | 260 --
.../api/v1/config/cachecfg/cachecfg_test.go | 221 --
traffic_ops/testing/api/v1/config/common.go | 187 --
traffic_ops/testing/api/v1/config/common_test.go | 158 --
traffic_ops/testing/api/v1/config/error.go | 81 -
.../testing/api/v1/config/ip_allow/ip_allow.go | 161 --
.../api/v1/config/ip_allow/ip_allow_test.go | 196 --
.../testing/api/v1/config/table_test_structs.go | 28 -
traffic_ops/testing/api/v1/cookie_test.go | 80 -
traffic_ops/testing/api/v1/coordinates_test.go | 100 -
traffic_ops/testing/api/v1/crconfig_test.go | 278 --
.../v1/deliveryservice_request_comments_test.go | 113 -
.../api/v1/deliveryservice_requests_test.go | 323 ---
.../api/v1/deliveryservice_safe_update_test.go | 100 -
.../testing/api/v1/deliveryservicematches_test.go | 49 -
.../deliveryservices_required_capabilities_test.go | 317 ---
.../testing/api/v1/deliveryservices_test.go | 602 -----
.../testing/api/v1/deliveryserviceservers_test.go | 253 --
.../api/v1/deliveryservicesideligible_test.go | 44 -
traffic_ops/testing/api/v1/divisions_test.go | 139 -
.../testing/api/v1/federation_resolvers_test.go | 220 --
.../testing/api/v1/federation_users_test.go | 157 --
traffic_ops/testing/api/v1/federations_test.go | 245 --
traffic_ops/testing/api/v1/fixtures_test.go | 43 -
traffic_ops/testing/api/v1/iso_test.go | 103 -
traffic_ops/testing/api/v1/jobs_test.go | 170 --
traffic_ops/testing/api/v1/loginfail_test.go | 129 -
traffic_ops/testing/api/v1/logs_test.go | 44 -
traffic_ops/testing/api/v1/monitoring_test.go | 50 -
traffic_ops/testing/api/v1/origins_test.go | 221 --
traffic_ops/testing/api/v1/parameters_test.go | 153 --
traffic_ops/testing/api/v1/phys_locations_test.go | 122 -
traffic_ops/testing/api/v1/ping_test.go | 32 -
.../testing/api/v1/profile_parameters_test.go | 176 --
traffic_ops/testing/api/v1/profiles_test.go | 373 ---
.../testing/api/v1/readonlycannotmodify_test.go | 69 -
traffic_ops/testing/api/v1/regions_test.go | 121 -
traffic_ops/testing/api/v1/roles_test.go | 181 --
.../testing/api/v1/servercapabilities_test.go | 86 -
traffic_ops/testing/api/v1/serverchecks_test.go | 145 --
traffic_ops/testing/api/v1/servers_test.go | 217 --
.../servers_to_deliveryservice_assignment_test.go | 129 -
.../testing/api/v1/serverservercapability_test.go | 232 --
traffic_ops/testing/api/v1/serversstatus_test.go | 52 -
.../testing/api/v1/serverupdatestatus_test.go | 237 --
traffic_ops/testing/api/v1/session_test.go | 54 -
.../testing/api/v1/staticdnsentries_test.go | 175 --
traffic_ops/testing/api/v1/stats_summary_test.go | 178 --
traffic_ops/testing/api/v1/statuses_test.go | 117 -
traffic_ops/testing/api/v1/steering_test.go | 67 -
traffic_ops/testing/api/v1/steeringtargets_test.go | 302 ---
traffic_ops/testing/api/v1/tc-fixtures.json | 2650 --------------------
traffic_ops/testing/api/v1/tenants_test.go | 313 ---
traffic_ops/testing/api/v1/todb_test.go | 375 ---
traffic_ops/testing/api/v1/toextension_test.go | 132 -
traffic_ops/testing/api/v1/traffic_control_test.go | 63 -
traffic_ops/testing/api/v1/traffic_ops_test.go | 107 -
traffic_ops/testing/api/v1/types_test.go | 120 -
traffic_ops/testing/api/v1/updatestatus_test.go | 37 -
traffic_ops/testing/api/v1/user_test.go | 463 ----
traffic_ops/testing/api/v1/withobjs_test.go | 119 -
traffic_ops/testing/api/v2/cachegroups_test.go | 5 +
traffic_ops/testing/api/v2/cdnfederations_test.go | 2 +-
.../api/v2/deliveryservice_requests_test.go | 3 +
.../testing/api/v2/deliveryservices_test.go | 11 +-
traffic_ops/testing/api/v2/divisions_test.go | 4 +
.../testing/api/v2/federation_users_test.go | 5 +-
traffic_ops/testing/api/v2/regions_test.go | 4 +
traffic_ops/testing/api/v2/statuses_test.go | 7 +-
traffic_ops/testing/api/v2/steeringtargets_test.go | 5 +-
traffic_ops/testing/api/v2/tenants_test.go | 7 +-
traffic_ops/testing/api/v3/cdnfederations_test.go | 2 +-
traffic_ops/testing/api/v4/cdnfederations_test.go | 2 +-
traffic_ops/traffic_ops_golang/asn/asns.go | 19 -
.../traffic_ops_golang/cachegroup/trimmed.go | 69 -
.../capabilities/capabilities.go | 96 +-
traffic_ops/traffic_ops_golang/cdn/configs.go | 59 -
traffic_ops/traffic_ops_golang/cdn/dnssec.go | 56 +-
traffic_ops/traffic_ops_golang/crconfig/handler.go | 103 +-
.../consistenthash/consistenthash.go | 3 +-
.../deliveryservice/deliveryservices.go | 273 +-
.../traffic_ops_golang/deliveryservice/keys.go | 191 +-
.../traffic_ops_golang/deliveryservice/matches.go | 125 -
.../traffic_ops_golang/deliveryservice/safe.go | 18 +-
.../deliveryservice/servers/delete.go | 45 +-
.../deliveryservice/servers/servers.go | 65 +-
.../deliveryservice/servers/servers_test.go | 2 +-
.../deliveryservicesregexes.go | 48 -
.../federation_resolvers/federation_resolvers.go | 55 -
.../traffic_ops_golang/federations/federations.go | 45 +-
.../federations/federations_test.go | 58 +-
traffic_ops/traffic_ops_golang/hwinfo/hwinfo.go | 136 -
.../traffic_ops_golang/hwinfo/hwinfo_test.go | 113 -
.../invalidationjobs/invalidationjobs.go | 7 +-
.../invalidationjobs/userinvalidationjobs.go | 212 --
.../traffic_ops_golang/login/logout_test.go | 2 +-
traffic_ops/traffic_ops_golang/logs/log.go | 32 +-
.../traffic_ops_golang/physlocation/trimmed.go | 63 -
traffic_ops/traffic_ops_golang/ping/keys.go | 45 -
traffic_ops/traffic_ops_golang/ping/riak.go | 53 -
traffic_ops/traffic_ops_golang/profile/trimmed.go | 63 -
.../profileparameter/parameterprofilebyname.go | 25 +-
.../profileparameter/unassignedparams.go | 71 -
traffic_ops/traffic_ops_golang/role/roles.go | 12 +-
traffic_ops/traffic_ops_golang/routing/routes.go | 481 +---
.../traffic_ops_golang/routing/routing_test.go | 69 +-
traffic_ops/traffic_ops_golang/server/detail.go | 70 -
traffic_ops/traffic_ops_golang/server/servers.go | 197 +-
.../traffic_ops_golang/server/status_count.go | 77 -
.../servercheck/extensions/extension.go | 52 +-
.../traffic_ops_golang/servercheck/servercheck.go | 20 -
.../trafficstats/deliveryservice.go | 74 +-
.../traffic_ops_golang/trafficstats/util_test.go | 2 +-
traffic_ops/traffic_ops_golang/types/types.go | 4 -
.../traffic_ops_golang/user/deliveryservices.go | 243 --
traffic_ops/traffic_ops_golang/vault/bucket.go | 14 +-
traffic_ops/v1-client/README.md | 53 -
traffic_ops/v1-client/about.go | 43 -
traffic_ops/v1-client/api_capability.go | 60 -
traffic_ops/v1-client/asn.go | 132 -
traffic_ops/v1-client/atsconfig.go | 88 -
traffic_ops/v1-client/cachegroup.go | 173 --
traffic_ops/v1-client/cachegroup_parameters.go | 126 -
traffic_ops/v1-client/capability.go | 84 -
traffic_ops/v1-client/cdn.go | 150 --
traffic_ops/v1-client/cdn_domains.go | 29 -
traffic_ops/v1-client/cdnfederations.go | 73 -
traffic_ops/v1-client/coordinate.go | 155 --
traffic_ops/v1-client/crconfig.go | 80 -
traffic_ops/v1-client/deliveryservice.go | 402 ---
traffic_ops/v1-client/deliveryservice_endpoints.go | 70 -
.../v1-client/deliveryservice_request_comments.go | 115 -
traffic_ops/v1-client/deliveryservice_requests.go | 243 --
.../deliveryservices_required_capabilities.go | 83 -
traffic_ops/v1-client/deliveryserviceserver.go | 119 -
traffic_ops/v1-client/division.go | 132 -
traffic_ops/v1-client/dsuser.go | 60 -
traffic_ops/v1-client/endpoints.go | 18 -
traffic_ops/v1-client/federation.go | 211 --
.../v1-client/federation_federation_resolver.go | 70 -
traffic_ops/v1-client/federation_resolver.go | 116 -
traffic_ops/v1-client/iso.go | 54 -
traffic_ops/v1-client/job.go | 176 --
traffic_ops/v1-client/log.go | 61 -
traffic_ops/v1-client/origin.go | 194 --
traffic_ops/v1-client/parameter.go | 221 --
traffic_ops/v1-client/phys_location.go | 143 --
traffic_ops/v1-client/ping.go | 39 -
traffic_ops/v1-client/profile.go | 257 --
traffic_ops/v1-client/profile_parameter.go | 115 -
traffic_ops/v1-client/region.go | 187 --
traffic_ops/v1-client/role.go | 160 --
traffic_ops/v1-client/server.go | 344 ---
.../v1-client/server_server_capabilities.go | 83 -
traffic_ops/v1-client/server_update_status.go | 80 -
traffic_ops/v1-client/servercapability.go | 104 -
traffic_ops/v1-client/servercheck.go | 54 -
traffic_ops/v1-client/serversstatus.go | 44 -
traffic_ops/v1-client/session.go | 498 ----
traffic_ops/v1-client/staticdnsentry.go | 180 --
traffic_ops/v1-client/stats_summary.go | 77 -
traffic_ops/v1-client/status.go | 150 --
traffic_ops/v1-client/steering.go | 38 -
traffic_ops/v1-client/steeringtarget.go | 96 -
traffic_ops/v1-client/tenant.go | 117 -
traffic_ops/v1-client/tenant_endpoints.go | 25 -
traffic_ops/v1-client/toextension.go | 69 -
traffic_ops/v1-client/traffic_monitor.go | 56 -
traffic_ops/v1-client/traffic_stats.go | 29 -
traffic_ops/v1-client/type.go | 151 --
traffic_ops/v1-client/update.go | 72 -
traffic_ops/v1-client/user.go | 209 --
traffic_ops/v1-client/util.go | 58 -
traffic_portal/app/src/scripts/config.js | 2 +-
.../1.3/cdns/name/thecdn/sslkeys-missing-1.json | 31 -
.../api/1.3/cdns/name/thecdn/sslkeys.json | 49 -
379 files changed, 315 insertions(+), 52374 deletions(-)
diff --git a/.github/workflows/traffic-ops.yml b/.github/workflows/traffic-ops.yml
index 0517523..4dbed96 100644
--- a/.github/workflows/traffic-ops.yml
+++ b/.github/workflows/traffic-ops.yml
@@ -97,24 +97,6 @@ jobs:
- name: Initialize Traffic Ops Database
id: todb
uses: ./.github/actions/todb-init
- - name: Run API v1 tests
- id: v1Tests
- if: ${{ steps.todb.outcome == 'success' && always() }}
- uses: ./.github/actions/to-integration-tests
- with:
- version: 1
- - name: Upload v1 Vault logs
- if: ${{ steps.v1Tests.outcome != 'success' && always() }}
- uses: actions/upload-artifact@v2
- with:
- name: v1 Traffic Vault logs
- path: ${{ github.workspace }}/infrastructure/cdn-in-a-box/traffic.vault.logs
- - name: Upload v1 Ops logs
- if: ${{ steps.v1Tests.outcome != 'success' && always() }}
- uses: actions/upload-artifact@v2
- with:
- name: v1 Traffic Ops logs
- path: ${{ github.workspace }}/traffic_ops/traffic_ops_golang/traffic.ops.log
- name: Run API v2 tests
id: v2Tests
if: ${{ steps.todb.outcome == 'success' && always() }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index de693c2..f8c9b93 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -120,6 +120,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Traffic Ops no longer includes an `app/public` directory, as the static webserver has been removed along with the Perl Traffic Ops implementation. Traffic Ops also no longer attempts to download MaxMind GeoIP City databases when running the Traffic Ops Postinstall script.
- The `compare` tool stack has been removed, as it no longer serves a purpose.
- Removed the Perl-only `cdn.conf` option `geniso.iso_root_path`
+- Traffic Ops API version 1
+
## [5.1.2] - 2021-05-17
### Fixed
diff --git a/cache-config/t3cutil/getdata.go b/cache-config/t3cutil/getdata.go
index 07f33d6..0b06bda 100644
--- a/cache-config/t3cutil/getdata.go
+++ b/cache-config/t3cutil/getdata.go
@@ -91,11 +91,13 @@ const SystemInfoParamConfigFile = `global`
// WriteSystemInfo writes the "system info" to output.
//
-// This is the same info at /api/1.x/system/info, which is actually just all Parameters with the config_file 'global'.
-// Note this is different than the more common "global parameters", which usually refers to all Parameters on the Profile named 'GLOBAL'.
-//
-// This is identical to the /api/1.x/system/info endpoint, except it does not include a '{response: {parameters:' wrapper.
+// This is the same info as the Traffic Ops API's /system/info endpoint, which
+// is actually just all Parameters with the config_file 'global'.
+// Note this is different than the more common "global parameters", which
+// usually refers to all Parameters on the Profile named 'GLOBAL'.
//
+// This is identical to the /system/info endpoint, except it does not include a
+// '{response: {parameters:' wrapper.
func WriteSystemInfo(cfg TCCfg, output io.Writer) error {
paramArr, _, err := cfg.TOClient.GetConfigFileParameters(SystemInfoParamConfigFile, nil)
if err != nil {
@@ -112,7 +114,8 @@ func WriteSystemInfo(cfg TCCfg, output io.Writer) error {
}
// WriteStatuses writes the Traffic Ops statuses to output.
-// Note this is identical to /api/1.x/statuses except it omits the '{response:' wrapper.
+// Note this is identical to /statuses except it omits the '{response:'
+// wrapper.
func WriteStatuses(cfg TCCfg, output io.Writer) error {
statuses, _, err := cfg.TOClient.GetStatuses(nil)
if err != nil {
@@ -124,8 +127,11 @@ func WriteStatuses(cfg TCCfg, output io.Writer) error {
return nil
}
-// WriteUpdateStatus writes the Traffic Ops server update status to output.
-// Note this is identical to /api/1.x/servers/name/update_status except it omits the '[]' wrapper.
+// WriteServerUpdateStatus writes the Traffic Ops server update status to
+// output.
+// Note this is identical to the Traffic Ops API's
+// /servers/{{host name}}/update_status endpoint except it omits the '[]'
+// wrapper.
func WriteServerUpdateStatus(cfg TCCfg, output io.Writer) error {
status, err := GetServerUpdateStatus(cfg)
if err != nil {
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
index 15bf1f1..2dc818a 100644
--- a/docs/source/api/index.rst
+++ b/docs/source/api/index.rst
@@ -20,50 +20,6 @@ Traffic Ops API
***************
The Traffic Ops API provides programmatic access to read and write Traffic Control data which allows for the monitoring of CDN performance and configuration of Traffic Control settings and parameters.
-API V1 Routes
-=============
-Documents all API version 1 routes.
-
-.. toctree::
- :maxdepth: 4
- :hidden:
- :glob:
-
- v1/*
-
-API V2 Routes
-=============
-Documents all API version 2 routes.
-
-.. toctree::
- :maxdepth: 4
- :hidden:
- :glob:
-
- v2/*
-
-API V3 Routes
-=============
-Documents all API version 3 routes.
-
-.. toctree::
- :maxdepth: 4
- :hidden:
- :glob:
-
- v3/*
-
-API V4 Routes
-=============
-Documents all API version 4 routes.
-
-.. toctree::
- :maxdepth: 4
- :hidden:
- :glob:
-
- v4/*
-
How to Read this Documentation
==============================
Each endpoint for each version is on its own page, titled with the request path. The request paths shown on each endpoint's page are - unless otherwise noted - only usable by being appended to the request path prefix ``/api/<version>/`` where ``<version>`` is the API version being requested. The API versions officially supported as of the time of this writing are 1.1, 1.2, 1.3, 1.4, 1.5, 2.0. All endpoints are documented as though they were being used in version 1.5 in the version 1 docu [...]
@@ -348,14 +304,36 @@ TrafficOps Native Client Libraries
==================================
TrafficOps client libraries are available in Java, Go and Python. You can read (very little) more about them in `the client README <https://github.com/apache/trafficcontrol/tree/master/traffic_control/clients>`_.
-.. [1] A cookie obtained by logging in through Traffic Portal can be used to access API endpoints under the Traffic Portal domain name - since it will proxy such requests back to Traffic Ops. This is not recommended in actual deployments, however, because it will involve an extra network connection which could be avoided by simply using the Traffic Ops domain itself.
-Migrating from API V1
-=====================
+API V2 Routes
+=============
+API routes available in version 2.
+
+.. toctree::
+ :maxdepth: 4
+ :glob:
+
+ v2/*
+
+API V3 Routes
+=============
+API routes available in version 3.
+
+.. toctree::
+ :maxdepth: 4
+ :glob:
+
+ v3/*
+
+API V4 Routes
+=============
+API routes available in version 4.
.. toctree::
- :hidden:
+ :maxdepth: 4
+ :glob:
+
+ v4/*
- migrating-from-v1
-See the :ref:`to-migrating` page for help migrating existing code from API v1 to a new API version.
+.. [1] A cookie obtained by logging in through Traffic Portal can be used to access API endpoints under the Traffic Portal domain name - since it will proxy such requests back to Traffic Ops. This is not recommended in actual deployments, however, because it will involve an extra network connection which could be avoided by simply using the Traffic Ops domain itself.
diff --git a/docs/source/api/migrating-from-v1.rst b/docs/source/api/migrating-from-v1.rst
deleted file mode 100644
index ee2ea6e..0000000
--- a/docs/source/api/migrating-from-v1.rst
+++ /dev/null
@@ -1,668 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-migrating:
-
-*********************
-Migrating from API V1
-*********************
-
-Versions 1.0, 1.1, 1.2, 1.3, 1.4, and 1.5 of the :ref:`to-api` have been deprecated since Apache Traffic Control version 4.0.0 and will be removed in Apache Traffic Control version 6.0.0. Any remaining users of 1.x endpoints of the Traffic Ops API are advised to upgrade to API version 3.0.
-
-Upgrading your Traffic Ops client
-=================================
-
-The easiest way to switch to a new API version is to use the latest version of a Traffic Ops client.
-
-Golang
-------
-
-If you are using the ``github.com/apache/trafficcontrol/traffic_ops/client`` package, use the :atc-godoc:`traffic_ops/v3-client` package instead.
-
-Python
-______
-
-Update to a newer version of the Apache-TrafficControl Python package.
-
-Updating endpoints manually
-============================
-
-If your code performs HTTP requests to a Traffic Ops API directly, it may be necessary to change which endpoint your code uses, in addition to simply changing the API version. The table below shows the easiest non-deprecated endpoint to use for each deprecated endpoint.
-
-.. role:: same
-.. |same| replace:: :same:`Same route`
-
-.. role:: none
-.. |none| replace:: :none:`No v3 equivalent`
-
-.. |atstccfg| replace:: Generated by :ref:`atstccfg`
-
-.. _to-migration-table:
-
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| HTTP method | v1 (deprecated) API route | v3 API route |
-+=============+=============================================================================+================================================================================================+
-| ``GET`` | :ref:`to-api-v3-about` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-api_capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-asns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-asns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-asns-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-asns-id` | :ref:`to-api-asns`?id={{id}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-asns-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-asns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-asns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-cachegroupparameters-id-parameterID` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroupparameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cachegroupparameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroups` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-cachegroups-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cachegroups-id-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroups-id` | :ref:`to-api-cachegroups`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroups-id-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-cachegroups-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cachegroups-id-queue_update` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroups-id-unassigned_parameters` | :ref:`to-api-v3-cachegroupparameters` and :ref:`to-api-parameters`?id={{id}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cachegroups` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cachegroups-trimmed` | :ref:`to-api-cachegroups` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-caches-stats` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cache_stats` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-capabilities` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-capacity` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-configs-monitoring` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/bg_fetch.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/cacheurl{{filename}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/hdr_rw_mid_{{xml-id}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/hdr_rw_{{xml-id}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/regex_remap_{{ds-name}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/regex_revalidate.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/set_dscp_{{dscp}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | cdns/{{cdn-name-or-id}}/configfiles/ats/ssl_multicert.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-id-snapshot` | :ref:`to-api-cdns-name-snapshot` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-snapshot` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-snapshot-new` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-config` | :ref:`to-api-cdns` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v3-cdns-dnsseckeys-generate` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-dnsseckeys-refresh` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-domains` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-health` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-cdns-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-id` | :ref:`to-api-cdns`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-cdns-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cdns-id-queue_update` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-cdns-id-snapshot` | :ref:`to-api-snapshot`?cdnID={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-metric_types-metric-start_date-start-end_date-end` | :ref:`to-api-deliveryservices-id-server_types-type-metric_types-start_date-start-end_date-end` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cdns-name-dnsseckeys-ksk-generate` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-cdns-name-federations-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-federations-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-cdns-name-federations-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cdns-name-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-health` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-cdns-name-name` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-name-dnsseckeys-delete` | ``DELETE`` :ref:`to-api-cdns-name-name-dnsseckeys` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-name-dnsseckeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-name` | :ref:`to-api-cdns`?name={{name}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-name-name-sslkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-cdns` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-cdns-routing` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-consistenthash` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-coordinates` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-coordinates` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-coordinates` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-coordinates` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-current-stats` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-dbdump` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | deliveryservice_matches | :ref:`to-api-deliveryservices_regexes` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v3-deliveryservice_request_comments` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-deliveryservice_request_comments` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v3-deliveryservice_request_comments` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v3-deliveryservice_request_comments` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v3-deliveryservice-requests` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-deliveryservice-requests` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v3-deliveryservice_requests-id-assign` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v3-deliveryservice_requests-id-status` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v3-deliveryservice-requests` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v3-deliveryservice-requests` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-regexes` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-id-regexes` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservices-id-regexes` | :ref:`to-api-deliveryservices-id-regexes-rid` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-deliveryservices-id-regexes` | :ref:`to-api-deliveryservices-id-regexes-rid` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservices-id-regexes-rid` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-regexes-rid` | :ref:`to-api-deliveryservices-id-regexes`?id={{rID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-deliveryservices-id-regexes-rid` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservice_server-dsid-serverid` | :ref:`to-api-deliveryserviceserver-dsid-serverid` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryserviceserver` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryserviceserver` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-hostname-name-sslkeys` | :ref:`to-api-deliveryservices-xmlid-xmlid-sslkeys` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-capacity` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservices-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id` | :ref:`to-api-deliveryservices`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-health` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-deliveryservices-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-routing` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-deliveryservices-id-safe` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-servers-eligible` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-servers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-id-unassigned_servers` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-deliveryservices-id-urlkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices_regexes` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-request` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservices-required-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-required-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-required-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-sslkeys-add` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-sslkeys-generate-letsencrypt` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-sslkeys-generate` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservice_stats` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-xmlid-xml_id-urlkeys-copyFrom_xml_id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-xmlid-xmlid-urlkeys-generate` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-xmlid-xmlid-urlkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-xmlid-servers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-deliveryservices-xmlid-urisignkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-xmlid-urisignkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-deliveryservices-xmlid-urisignkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-deliveryservices-xmlid-urisignkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-xmlid-xmlid-sslkeys-delete` | :ref:`to-api-deliveryservices-xmlid-xmlid-sslkeys` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-deliveryservices-xmlid-xmlid-sslkeys` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-divisions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-divisions-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-divisions-id` | :ref:`to-api-divisions`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-divisions-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | divisions/name/{{name}} | :ref:`to-api-divisions`?name={{name}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-divisions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-federation_resolvers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-federation_resolvers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-federation_resolvers-id` | :ref:`to-api-federation_resolvers`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-federation_resolvers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-federations-all` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-federations-id-deliveryservices-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-federations-id-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-federations-id-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-federations-id-federation_resolvers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-federations-id-federation_resolvers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-federations-id-users` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-federations-id-users` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-federations-id-users-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-federations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-hwinfo` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-jobs` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-jobs` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-jobs-id` | :ref:`to-api-jobs`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-jobs` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-jobs` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-keys-ping` | :ref:`to-api-vault-ping` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-letsencrypt-autorenew` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-letsencrypt-dnsrecord` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-logs-days-days` | :ref:`to-api-logs`?days={{days}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-logs` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-logs-newcount` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-origins` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-origins` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-origins` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-origins` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-osversions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-parameterprofile` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-parameters-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-parameters-id` | :ref:`to-api-parameters`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-parameters-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-parameters-profile-name` | :ref:`to-api-profiles-name-name-parameters` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-phys_locations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-phys_locations-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-phys_locations-id` | :ref:`to-api-phys_locations`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-phys_locations-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-phys_locations` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-phys_locations-trimmed` | :ref:`to-api-phys_locations` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-ping` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profileparameter` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profileparameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profileparameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-profileparameters-profileID-parameterID` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-profiles-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-id-export` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-id-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profiles-id-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-profiles-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-id-unassigned_parameters` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profiles-import` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-name-name-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profiles-name-name-parameters` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profiles-name-name-copy-copy` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-profiles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/12m_facts | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/50-ats.rules | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/astats.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/cache.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/drop_qstring.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/{{file}} | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/logging.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/logging.yaml | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/logs_xml.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/plugin.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/records.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/storage.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/sysctl.conf | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/uri_signing_{{file}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/url_sig_{{file}}.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | profiles/{{profile-name-or-id}}/configfiles/ats/volume.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-profiles-trimmed` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-regions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-regions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-regions-id` | :ref:`to-api-regions`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-regions-id` | :ref:`to-api-regions`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-regions-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | regions/name/{{name}} | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | regions/name/{{name}} | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-regions` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-riak-bucket-bucket-key-key-values` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-riak-ping` | :ref:`to-api-vault-ping` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-roles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-roles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-roles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-roles` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-server_capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-server_capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-server_capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-servercheck` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-checks` | :ref:`to-api-servercheck` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-servers-details` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-server-server-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-server-server-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-server-server-capabilities` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-hostname-name-details` | :ref:`to-api-servers-details`?hostName={{name}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-hostname-update_status` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-servers-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{ID}}/deliveryservice | servers/{{ID}}/deliveryservices |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-id-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-servers-id-deliveryservices` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-id` | :ref:`to-api-servers`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{id-or-host}}/configfiles/ats/cache.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{id-or-host}}/configfiles/ats/chkconfig | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{id-or-host}}/configfiles/ats/{{file}} | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{id-or-host}}/configfiles/ats/hosting.config | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{id-or-host}}/configfiles/ats/packages | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-servers-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-servers-id-queue_update` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-servers-id-status` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-servers` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | servers/{{server-name-or-id}}/configfiles/ats | |atstccfg| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-status` | :ref:`to-api-servers` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-servers-totals` | |none| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-snapshot-name` | :ref:`to-api-snapshot` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-staticdnsentries` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-staticdnsentries` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-staticdnsentries` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-staticdnsentries` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-stats-summary` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-stats-summary` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-statuses` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-statuses-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-statuses-id` | :ref:`to-api-statuses`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-statuses-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-statuses` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-steering-id-targets` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-steering-id-targets` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-steering-id-targets-targetID` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-steering-id-targets-targetID` | :ref:`to-api-steering-id-targets`?target={{targetID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-steering-id-targets-targetID` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v3-steering` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-system-info` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-tenants` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-tenants-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-tenants-id` | :ref:`to-api-tenants`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-tenants-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-tenants` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-to_extensions` | :ref:`to-api-servercheck_extensions` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-to_extensions-id-delete` | :ref:`to-api-servercheck_extensions-id` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-to_extensions` | :ref:`to-api-servercheck_extensions` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-types` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``DELETE`` | :ref:`to-api-v1-types-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-types-id` | :ref:`to-api-types`?id={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-types-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-types` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-types-trimmed` | :ref:`to-api-types` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-user-current` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-user-current-jobs` | :ref:`to-api-jobs`?userId={{ID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-current-jobs` | :ref:`to-api-jobs` |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-user-current` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-user-id-deliveryservices-available` | :ref:`to-api-deliveryservices`?accessibleTo={{tenantID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-login-oauth` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-login` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-login-token` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-logout` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-user-reset_password` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-users` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-users-id-deliveryservices` | :ref:`to-api-deliveryservices`?accessibleTo={{tenantID}} |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``GET`` | :ref:`to-api-v1-users-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``PUT`` | :ref:`to-api-v1-users-id` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-users` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
-| ``POST`` | :ref:`to-api-v1-users-register` | |same| |
-+-------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
diff --git a/docs/source/api/v1/api_capabilities.rst b/docs/source/api/v1/api_capabilities.rst
deleted file mode 100644
index 9a56f0e..0000000
--- a/docs/source/api/v1/api_capabilities.rst
+++ /dev/null
@@ -1,184 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-api_capabilities:
-
-********************
-``api_capabilities``
-********************
-Deals with the capabilities that may be associated with API endpoints and methods. These capabilities are assigned to :term:`Roles`, of which a user may have one or more. Capabilities support "wildcarding" or "globbing" using asterisks to group multiple routes into a single capability
-
-``GET``
-=======
-Get all API-capability mappings.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +----------------+----------+--------+------------------------------------+
- | Name | Required | Type | Description |
- +================+==========+========+====================================+
- | capability | no | string | Capability name |
- +----------------+----------+--------+------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.1/api_capabilities?capability=types-write HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, practically one of:
-
- - ``GET``
- - ``POST``
- - ``PUT``
- - ``PATCH``
- - ``DELETE``
-
-:httpRoute: The request route for which this capability applies - relative to the Traffic Ops server's URL
-:id: An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Thu, 01 Nov 2018 14:45:24 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: wptErtIop/AfTTQ+1MZdA2YpPXEOuLFfrPQvvaHqO/uX5fRruOVYW+7p8JTrtH1xg1WN+x6FnjQnSHuWwcpyJg==
- Content-Length: 393
-
- { "response": [
- {
- "httpMethod": "POST",
- "lastUpdated": "2018-11-01 14:10:22.794114+00",
- "httpRoute": "types",
- "id": 261,
- "capability": "types-write"
- },
- {
- "httpMethod": "PUT",
- "lastUpdated": "2018-11-01 14:10:22.795917+00",
- "httpRoute": "types/*",
- "id": 262,
- "capability": "types-write"
- },
- {
- "httpMethod": "DELETE",
- "lastUpdated": "2018-11-01 14:10:22.799748+00",
- "httpRoute": "types/*",
- "id": 263,
- "capability": "types-write"
- }
- ]}
-
-``POST``
-========
-.. deprecated:: 1.1
- This endpoint does not have an alternative. API Capabilities must be seeded when new endpoints are created.
-
-Create an API-capability mapping.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, one of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'
-:httpRoute: The API endpoint for which to create capabilities
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.1/api_capabilities HTTP/1.1
- Host: ipcdn-cache-51.cdnlab.comcast.net:6443
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 94
- Content-Type: application/x-www-form-urlencoded
-
- {
- "capability": "types-write",
- "httpRoute": "/api/1.1/api_capabilities",
- "httpMethod": "PATCH"
- }
-
-Response Structure
-------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, practically one of:
-
- - ``GET``
- - ``POST``
- - ``PUT``
- - ``PATCH``
- - ``DELETE``
-
-:httpRoute: The request route for which this capability applies - relative to the Traffic Ops server's URL
-:id: An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Thu, 01 Nov 2018 14:53:58 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: CDz5DUJFoL5DgfnCcvitPmnKJAG5VENhNN6wz2YNqqW1n5HQzSci+NsU5SqfhKnTwnKfSy7PYl9hQhrUKO6KCQ==
- Content-Length: 209
-
- { "alerts": [
- {
- "level": "success",
- "text": "API-Capability mapping was created."
- }
- ],
- "response": {
- "httpMethod": "PATCH",
- "lastUpdated": null,
- "httpRoute": "/api/1.1/api_capabilities",
- "id": 273,
- "capability": "types-write"
- }}
diff --git a/docs/source/api/v1/api_capabilities_id.rst b/docs/source/api/v1/api_capabilities_id.rst
deleted file mode 100644
index d7a06af..0000000
--- a/docs/source/api/v1/api_capabilities_id.rst
+++ /dev/null
@@ -1,262 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-api_capabilities-id:
-
-***************************
-``api_capabilities/{{ID}}``
-***************************
-Manages a specific API capability.
-
-``GET``
-=======
-.. deprecated:: ATCv4
-
-Get an API-capability mapping by id.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-------------+----------+---------+-----------------------------------------+
- | Name | Required | Type | Description |
- +=============+==========+=========+=========================================+
- | ID | yes | integer | A unique identifier for this capability |
- +-------------+----------+---------+-----------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.1/api_capabilities/273 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-
-Response Structure
-------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, practically one of:
-
- * ``GET``
- * ``POST``
- * ``PUT``
- * ``PATCH``
- * ``DELETE``
-
-:httpRoute: The request route for which this capability applies - relative to the Traffic Ops server's URL
-:id: An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Thu, 01 Nov 2018 16:14:09 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: SMSFHOcD6VvfJKmcHmHBQcN+jkRRCmFzx1jyBWhJeyPg04YHPSvUcjZzslWlJqyjwWeoXeNVwxhRkBwl8TQX/g==
- Content-Length: 162
-
- {
- "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /api_capabilities' instead"
- }
- ],
- "response": [
- {
- "httpMethod": "PATCH",
- "lastUpdated": "2018-11-01 14:53:58.853356+00",
- "httpRoute": "/api/1.1/api_capabilities",
- "id": 273,
- "capability": "types-write"
- }
- ]}
-
-``PUT``
-=======
-.. deprecated:: 1.1
- This endpoint does not have an alternative. API Capabilities can only be modified at the database seeding level.
-
-Edit an API-capability mapping.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, practically one of:
-
- * ``GET``
- * ``POST``
- * ``PUT``
- * ``PATCH``
- * ``DELETE``
-
-:httpRoute: The request route for which this capability applies - relative to the Traffic Ops server's URL
-
-.. table:: Request Path Parameters
-
- +-------------+----------+---------+-----------------------------------------+
- | Name | Required | Type | Description |
- +=============+==========+=========+=========================================+
- | id | yes | integer | A unique identifier for this capability |
- +-------------+----------+---------+-----------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.1/api_capabilities/273 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 98
- Content-Type: application/x-www-form-urlencoded
-
- {
- "capability": "types-write",
- "httpRoute": "/api/1.1/api_capabilities/*",
- "httpMethod": "PATCH"
- }
-
-Response Structure
-------------------
-:capability: Capability name
-:httpMethod: An HTTP request method, practically one of:
-
- * ``GET``
- * ``POST``
- * ``PUT``
- * ``PATCH``
- * ``DELETE``
-
-:httpRoute: The request route for which this capability applies - relative to the Traffic Ops server's URL
-:id: An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Thu, 01 Nov 2018 18:28:38 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: zQuDrqpJt02Fh2fNZ6K7/XmVJ49ZqGTnSbsaR7nOyoxbkmLM17XJV1rtef/SAows2M4j4YjcDbEP4WM/hjCFtw==
- Content-Length: 241
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "API-Capability mapping was updated."
- },
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use '[NO ALTERNATE - See https://traffic-control-cdn.readthedocs.io/en/latest/api/api_capabilities_id.html#put]' instead"
- }
- ],
- "response": {
- "httpMethod": "PATCH",
- "lastUpdated": "2018-11-01 18:28:10.38317+00",
- "httpRoute": "/api/1.1/api_capabilities/*",
- "id": 273,
- "capability": "types-write"
- }
- }
-
-``DELETE``
-==========
-.. deprecated:: 1.1
- This endpoint does not have an alternative. API Capabilities can only be deleted at the database seeding level.
-
-Delete a capability.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-------------+----------+---------+-----------------------------------------+
- | Name | Required | Type | Description |
- +=============+==========+=========+=========================================+
- | id | yes | integer | A unique identifier for this capability |
- +-------------+----------+---------+-----------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.1/api_capabilities/273 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 07 Nov 2018 15:44:14 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: eTFJkB2Bh8SCT2A29e21e8qoEdNzFGfuT5a3tDG7u8vwz/JHntQRRR8554a1i65733uWojlWKM65bLSDNmmNqQ==
- Content-Length: 73
-
- { "alerts": [
- {
- "level": "success",
- "text": "API-capability mapping deleted."
- },
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use '[NO ALTERNATE - See https://traffic-control-cdn.readthedocs.io/en/latest/api/api_capabilities_id.html#delete]' instead"
- }
- ]}
diff --git a/docs/source/api/v1/asns.rst b/docs/source/api/v1/asns.rst
deleted file mode 100644
index 8f62098..0000000
--- a/docs/source/api/v1/asns.rst
+++ /dev/null
@@ -1,173 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v1-asns:
-
-********
-``asns``
-********
-.. seealso:: `The Autonomous System Wikipedia page <https://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29>`_ for an explanation of what an :abbr:`ASN (Autonomous System Number)` actually is.
-
-``GET``
-=======
-List all :abbr:`ASNs (Autonomous System Numbers)`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
- .. versionchanged:: 1.2
- Previously was an object with only one key ("asns") that contained the response array. This has been flattened so that the response is the actual array.
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Required | Description |
- +============+==========+=====================================================================================================+
- | cachegroup | no | The :ref:`cache-group-id` of a :term:`Cache Group` - only :abbr:`ASNs (Autonomous System Numbers)` |
- | | | for this :term:`Cache Group` will be returned. |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the |
- | | | ``response`` array |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with |
- | | | limit |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are |
- | | | ``limit`` long and the first page is 1. If ``offset`` was defined, this query parameter has no |
- | | | effect. ``limit`` must be defined to make use of ``page``. |
- +------------+----------+-----------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/asns HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:51:14 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: F2NmDbTpXqrIQDX7IBKH9+1drtTL4XedSfJv6klMgLEZwbLCkddIXuSLpmgVCID6kTVqy3fTKjZS3U+HJ3YUEQ==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 02 Dec 2019 21:51:14 GMT
- Content-Length: 128
-
- { "response": [
- {
- "asn": 1,
- "cachegroup": "TRAFFIC_ANALYTICS",
- "cachegroupId": 1,
- "id": 1,
- "lastUpdated": "2019-12-02 21:49:08+00"
- }
- ]}
-
-
-
-``POST``
-========
-Creates a new :abbr:`ASN (Autonomous System Number)`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
-:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
-
- .. note:: While this endpoint accepts the ``cachegroup`` field, sending this in the request payload has no effect except that the response will (erroneously) name the :term:`Cache Group` to which the :abbr:`ASN (Autonomous System Number)` was assigned. Any subsequent requests will reveal that, in fact, the :term:`Cache Group` is set entirely by the ``cachegroupId`` field, and so the actual :ref:`cache-group-name` may differ from what was in the request.
-
-:cachegroupId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/asns HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 29
-
- {"asn": 1, "cachegroupId": 1}
-
-
-Response Structure
-------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:49:08 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: mx8b2GTYojz4QtMxXCMoQyZogCB504vs0yv6WGly4dwM81W3XiejWNuUwchRBYYi8QHaWsMZ3DaiGGfQi/8Giw==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 02 Dec 2019 21:49:08 GMT
- Content-Length: 150
-
- { "alerts": [
- {
- "text": "asn was created.",
- "level": "success"
- }
- ],
- "response": {
- "asn": 1,
- "cachegroup": null,
- "cachegroupId": 1,
- "id": 1,
- "lastUpdated": "2019-12-02 21:49:08+00"
- }}
diff --git a/docs/source/api/v1/asns_id.rst b/docs/source/api/v1/asns_id.rst
deleted file mode 100644
index 0f8ea96..0000000
--- a/docs/source/api/v1/asns_id.rst
+++ /dev/null
@@ -1,224 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v1-asns-id:
-
-***************
-``asns/{{id}}``
-***************
-.. seealso:: `The Autonomous System Wikipedia page <https://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29>`_ for an explanation of what an :abbr:`ASN (Autonomous System Number)` actually is.
-
-``GET``
-=======
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-asns` with query parameter ``id`` instead.
-
-Retrieve information about a specific :abbr:`ASN (Autonomous System Number)`-to-:term:`Cache Group` association.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+==========================================================================================================================+
- | id | yes | The integral, unique identifier of the desired :abbr:`ASN (Autonomous System Number)`-to-:term:`Cache Group` association |
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Structure
-
- GET /api/1.1/asns/1 HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:53:17 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: F2NmDbTpXqrIQDX7IBKH9+1drtTL4XedSfJv6klMgLEZwbLCkddIXuSLpmgVCID6kTVqy3fTKjZS3U+HJ3YUEQ==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 02 Dec 2019 21:53:17 GMT
- Content-Length: 210
-
- { "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use GET /asns instead"
- }
- ],
- "response": [
- {
- "asn": 1,
- "cachegroup": "TRAFFIC_ANALYTICS",
- "cachegroupId": 1,
- "id": 1,
- "lastUpdated": "2019-12-02 21:49:08+00"
- }
- ]}
-
-``PUT``
-=======
-Allows user to edit an existing :abbr:`ASN (Autonomous System Number)`-to-:term:`Cache Group` association.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:asn: The new :abbr:`ASN (Autonomous System Number)` which will be associated with the identified :term:`Cache Group` - must not conflict with existing associations
-:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
-
- .. note:: While this endpoint accepts the ``cachegroup`` field, sending this in the request payload has no effect except that the response will (erroneously) name the :term:`Cache Group` to which the :abbr:`ASN (Autonomous System Number)` was assigned. Any subsequent requests will reveal that, in fact, the :term:`Cache Group` is set entirely by the ``cachegroupId`` field, and so the actual :ref:`cache-group-name` may differ from what was in the request.
-
-:cachegroupId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned - must not conflict with existing associations
-
-
-.. table:: Request Path Parameters
-
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+==========================================================================================================================+
- | id | yes | The integral, unique identifier of the desired :abbr:`ASN (Autonomous System Number)`-to-:term:`Cache Group` association |
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
-
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/asns/1 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 29
- Content-Type: application/x-www-form-urlencoded
-
- {"asn": 2, "cachegroupId": 1}
-
-Response Structure
-------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: /83P4LJVsrQx9BKHFxo5pbhQMlB4o3a9v3PpkspyOJcpNx1S/GJhCPpiANBki547sbY+0vTq76IriHZ4GYp8bA==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 08 Nov 2018 14:37:39 GMT
- Content-Length: 160
-
- { "alerts": [
- {
- "text": "asn was updated.",
- "level": "success"
- }
- ],
- "response": {
- "asn": 2,
- "cachegroup": null,
- "cachegroupId": 1,
- "id": 1,
- "lastUpdated": "2018-11-08 14:37:39+00"
- }}
-
-``DELETE``
-==========
-Deletes an association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+==========================================================================================================================+
- | id | yes | The integral, unique identifier of the desired :abbr:`ASN (Autonomous System Number)`-to-:term:`Cache Group` association |
- +------+----------+--------------------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.4/asns/1 HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 0
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 23:06:24 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 6t3WA+DOcfPJB5UnvDpzEVx5ySfmJgEV9wgkO71U5k32L1VXpxcaTdDVLNGgDDl9sdNftmYnKXf5jpfWUuFYJQ==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 02 Dec 2019 22:06:24 GMT
- Content-Length: 81
-
- { "alerts": [
- {
- "text": "asn was deleted.",
- "level": "success"
- }
- ]}
diff --git a/docs/source/api/v1/cache_stats.rst b/docs/source/api/v1/cache_stats.rst
deleted file mode 100644
index cba82e3..0000000
--- a/docs/source/api/v1/cache_stats.rst
+++ /dev/null
@@ -1,171 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cache_stats:
-
-***************
-``cache_stats``
-***************
-Retrieves detailed, aggregated statistics for caches in a specific CDN.
-
-.. versionadded:: 1.2
-
-.. seealso:: This gives an aggregate of statistics for *all caches* within a particular CDN and time range. For statistics basic statistics from all caches regardless of CDN and at the current time, use :ref:`to-api-v1-caches-stats`.
-
-``GET``
--------
-Retrieves statistics about the caches within the CDN
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=====================+===================+===========================================================================================================================================================================================+
- | cdnName | yes | The name of a CDN. Results will represent caches within this CDN |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | endDate | yes | The date and time until which statistics shall be aggregated in :rfc:`3339` format (with or without sub-second precision), the number of nanoseconds since the Unix |
- | | | Epoch, or in the same, proprietary format as the ``lastUpdated`` fields prevalent throughout the Traffic Ops API |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | exclude | no | Either "series" to omit the data series from the result, or "summary" to omit the summary data from the result - directly corresponds to fields in the |
- | | | `Response Structure`_ |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | interval | no | Specifies the interval within which data will be "bucketed"; e.g. when requesting data from 2019-07-25T00:00:00Z to 2019-07-25T23:59:59Z with an interval of "1m", |
- | | | the resulting data series (assuming it is not excluded) should contain |
- | | | :math:`24\frac{\mathrm{hours}}{\mathrm{day}}\times60\frac{\mathrm{minutes}}{\mathrm{hour}}\times1\mathrm{day}\times1\frac{\mathrm{minute}}{\mathrm{data point}}=1440\mathrm{data\;points}`|
- | | | The allowed values for this parameter are valid InfluxQL duration literal strings matching :regexp:`^\d+[mhdw]$` |
- | | | |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | limit | no | A natural number indicating the maximum amount of data points should be returned in the ``series`` object |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | metricType | yes | The metric type being reported - one of: 'connections', 'bandwidth', 'maxkbps' |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | offset | no | A natural number of data points to drop from the beginning of the returned data set |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Though one struggles to imagine why, this can be used to specify "time" to sort data points by their "time" (which is the default behavior) |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | startDate | yes | The date and time from which statistics shall be aggregated in :rfc:`3339` format (with or without sub-second precision), the number of nanoseconds since the Unix |
- | | | Epoch, or in the same, proprietary format as the ``lastUpdated`` fields prevalent throughout the Traffic Ops API |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. _cache_stats_v1-get-request-example:
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cache_stats?cdnName=CDN&endDate=2019-10-28T20:49:00Z&metricType=bandwidth&startDate=2019-10-28T20:45:00Z HTTP/1.1
- User-Agent: python-requests/2.20.1
- Accept-Encoding: gzip, deflate
- Accept: application/json;timestamp=unix, application/json;timestamp=rfc;q=0.9, application/json;q=0.8, */*;q=0.7
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Content Format
-""""""""""""""
-It's important to note in :ref:`cache_stats_v1-get-request-example` the use of a complex "Accept" header. This endpoint accepts two special media types in the "Accept" header that instruct it on how to format the timestamps associated with the returned data. Specifically, Traffic Ops will recognize the special, optional, non-standard parameter of :mimetype:`application/json`: ``timestamp``. The values of this parameter are restricted to one of
-
-rfc
- Returned timestamps will be formatted according to :rfc:`3339` (no sub-second precision).
-unix
- Returned timestamps will be formatted as the number of nanoseconds since the Unix Epoch (midnight on January 1\ :sup:`st` 1970 UTC).
-
- .. impl-detail:: The endpoint passes back nanoseconds, specifically, because that is the form used both by InfluxDB, which is used to store the data being served, and Go's standard library. Clients may need to convert the value to match their own standard libraries - e.g. the :js:class:`Date` class in Javascript expects milliseconds.
-
-The default behavior - when only e.g. :mimetype:`application/json` or :mimetype:`*/*` is given - is to use :rfc:`3339` formatting. It will, however, respect quality parameters. It is suggested that clients request timestamps they can handle specifically, rather than relying on this default behavior, as it **is subject to change** and is in fact **expected to invert in the next major release** as string-based time formats become deprecated.
-
-.. seealso:: For more information on the "Accept" HTTP header, consult `its dedicated page on MDN <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept>`_.
-
-Response Structure
-------------------
-:series: An object containing the actual data series and information necessary for working with it.
-
- :columns: This is an array of names of the columns of the data contained in the "values" array - should always be ``["time", "sum_count"]``
- :count: The number of data points contained in the "values" array
- :name: The name of the data set. Should always match :samp:`{metric}.ds.1min` where ``metric`` is the requested ``metricType``
- :values: The actual array of data points. Each represents a length of time specified by the ``interval`` query parameter
-
- :time: The time at which the measurement was taken. This corresponds to the *beginning* of the interval. This time comes in the format of either an :rfc:`3339`-formatted string, or a number containing the number of nanoseconds since the Unix Epoch depending on the "Accept" header sent by the client, according to the rules outlined in `Content Format`_.
- :value: The value of the requested ``metricType`` at the time given by ``time``. This will always be a floating point number, unless no data is available for the data interval, in which case it will be ``null``
-
-:summary: A summary of the data contained in the "series" object
-
- :average: The arithmetic mean of the data's values
- :count: The number of measurements taken within the requested timespan. This is, in general, **not** the same as the ``count`` field of the ``series`` object, as it reflects the number of underlying, un-"bucketed" data points, and is therefore dependent on the implementation of Traffic Stats.
- :fifthPercentile: Data points with values less than or equal to this number constitute the "bottom" 5% of the data set
- :max: The maximum value that can be found in the requested data set
- :min: The minimum value that can be found in the requested data set
- :ninetyEighthPercentile: Data points with values greater than or equal to this number constitute the "top" 2% of the data set
- :ninetyFifthPercentile: Data points with values greater than or equal to this number constitute the "top" 5% of the data set
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: p4asf1n7fXGtgpW/dWgolJWdXjwDcCjyvjOPFqkckbgoXGUHEj5/wlz7brlQ48t3ZnOWCqOlbsu2eSiBssBtUQ==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 28 Oct 2019 20:49:51 GMT
-
- { "response": {
- "series": {
- "columns": [
- "time",
- "sum_count"
- ],
- "count": 4,
- "name": "bandwidth.cdn.1min",
- "tags": {
- "cdn": "CDN-in-a-Box"
- },
- "values": [
- [
- 1572295500000000000,
- null
- ],
- [
- 1572295560000000000,
- 113.66666666666666
- ],
- [
- 1572295620000000000,
- 108.83333333333334
- ],
- [
- 1572295680000000000,
- 113
- ]
- ]
- },
- "summary": {
- "average": 111.83333333333333,
- "count": 3,
- "fifthPercentile": 0,
- "max": 113.66666666666666,
- "min": 108.83333333333334,
- "ninetyEighthPercentile": 113.66666666666666,
- "ninetyFifthPercentile": 113.66666666666666
- }
- }}
diff --git a/docs/source/api/v1/cachegroup_fallbacks.rst b/docs/source/api/v1/cachegroup_fallbacks.rst
deleted file mode 100644
index c301a14..0000000
--- a/docs/source/api/v1/cachegroup_fallbacks.rst
+++ /dev/null
@@ -1,303 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroup_fallbacks:
-
-************************
-``cachegroup_fallbacks``
-************************
-
-.. deprecated:: 1.4
-
- The :ref:`to-api-v1-cachegroups` and :ref:`to-api-v1-cachegroups-id` endpoints now contain a list of :ref:`cache-group-fallbacks` in the output, and support it in input, and so this endpoint is redundant.
-
-``GET``
-=======
-Retrieve the :ref:`cache-group-fallbacks` of a :term:`Cache Group`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +--------------+----------+-----------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==============+==========+===========================================================================================================+
- | cacheGroupId | yes | The :ref:`cache-group-id` of a :term:`Cache Group` whose :ref:`cache-group-fallbacks` shall be retrieved |
- +--------------+----------+-----------------------------------------------------------------------------------------------------------+
- | fallbackId | no | The integral, unique identifier of a single :ref:`"fallback" <cache-group-fallbacks>` :term:`Cache Group` |
- +--------------+----------+-----------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cachegroup_fallbacks?cacheGroupId=7 HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` described by this entry
-:cacheGroupName: The :ref:`cache-group-name` of the :term:`Cache Group` described by this entry as a string
-:fallbackId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back"
-:fallbackName: The :ref:`cache-group-name` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back" as a string
-:fallbackOrder: The place in the list of :ref:`cache-group-fallbacks` of the :term:`Cache Group` identified by ``cacheGroupId`` and ``cacheGroupName`` where the :term:`Cache Group` identified by ``fallbackId`` and ``fallbackName`` starting from index 1.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 189
- Content-Type: application/json
- Date: Mon, 02 Dec 2019 22:26:27 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Tue, 03 Dec 2019 02:26:27 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: zSAeB8nxonyinsg1/at/l0/9FRRPw7N27DpkcZxRIwEzDOEY5XVfYcCHHFg1d/Q2JWtWZ9iRhs8mK5rLbKkccw==
-
- { "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /cachegroups' instead"
- }
- ],
- "response": [
- {
- "cacheGroupId": 7,
- "fallbackOrder": 2,
- "fallbackName": "test",
- "fallbackId": 8,
- "cacheGroupName": "CDN_in_a_Box_Edge"
- }
- ]}
-
-
-``POST``
-========
-Creates :ref:`"fallback" <cache-group-fallbacks>` configuration for a :term:`Cache Group`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Array
-
-Request Structure
------------------
-The request payload for this endpoint **must** be an array, even if only one "fallback" relationship is being created.
-
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` to which to assign a :ref:`fallback <cache-group-fallbacks>`
-:fallbackId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` on which the :term:`Cache Group` identified by ``cacheGroupId`` will "fall back"
-:fallbackOrder: The place in the list of :ref:`cache-group-fallbacks` of the :term:`Cache Group` identified by ``cacheGroupId`` and ``cacheGroupName`` where the :term:`Cache Group` identified by ``fallbackId`` and ``fallbackName`` starting from index 1.
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/cachegroup_fallbacks HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 57
-
- [{"cacheGroupId": 7, "fallbackId": 8, "fallbackOrder": 2}]
-
-Response Structure
-------------------
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` described by this entry
-:cacheGroupName: The :ref:`cache-group-name` of the :term:`Cache Group` described by this entry as a string
-:fallbackId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back"
-:fallbackName: The :ref:`cache-group-name` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back" as a string
-:fallbackOrder: The place in the list of :ref:`cache-group-fallbacks` of the :term:`Cache Group` identified by ``cacheGroupId`` and ``cacheGroupName`` where the :term:`Cache Group` identified by ``fallbackId`` and ``fallbackName`` starting from index 1.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 174
- Content-Type: application/json
- Date: Mon, 02 Dec 2019 22:23:22 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Tue, 03 Dec 2019 02:23:22 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: S8CMeR3P22itBNYOQaIjiQPMDoq2AzGt0/oBYpMPm1b8/iKeZfGSS4zyt4WYbVJrgrzFZYGUhBEJe6uimQYdCQ==
-
- { "alerts": [
- {
- "level": "success",
- "text": "Backup configuration CREATE for cache group 7 successful."
- },
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'POST /cachegroups with a non-empty 'fallbacks' array' instead"
- }
- ]}
-
-
-``PUT``
-=======
-Updates an existing :ref:`fallback <cache-group-fallbacks>` configuration for one or more :term:`Cache Groups`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Array
-
-Request Structure
------------------
-The request payload for this endpoint **must** be an array, even if only one fallback relationship is being updated.
-
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` to which to assign a :ref:`fallback <cache-group-fallbacks>`
-:fallbackId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` on which the :term:`Cache Group` identified by ``cacheGroupId`` will "fall back"
-:fallbackOrder: The place in the list of :ref:`cache-group-fallbacks` of the :term:`Cache Group` identified by ``cacheGroupId`` and ``cacheGroupName`` where the :term:`Cache Group` identified by ``fallbackId`` and ``fallbackName`` starting from index 1.
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/cachegroup_fallbacks HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 58
-
- [{"cacheGroupId": 7, "fallbackId": 8, "fallbackOrder": 2}]
-
-Response Structure
-------------------
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` described by this entry
-:cacheGroupName: The :ref:`cache-group-name` of the :term:`Cache Group` described by this entry as a string
-:fallbackId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back"
-:fallbackName: The :ref:`cache-group-name` of the :term:`Cache Group` on which the :term:`Cache Group` described by this entry will "fall back" as a string
-:fallbackOrder: The place in the list of :ref:`cache-group-fallbacks` of the :term:`Cache Group` identified by ``cacheGroupId`` and ``cacheGroupName`` where the :term:`Cache Group` identified by ``fallbackId`` and ``fallbackName`` starting from index 1.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 237
- Content-Type: application/json
- Date: Mon, 02 Dec 2019 22:28:55 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Tue, 03 Dec 2019 02:28:55 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: /rGLP3gbnqFUjDhC/4mSYr2a2HoVsGTukxHX8CbURnwDS5LV7U6gwvlOcgtMfEUyX1FEa4+1Xa94tiL/dRFj6w==
-
- { "alerts": [
- {
- "level": "success",
- "text": "Backup configuration UPDATE for cache group 7 successful."
- },
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'PUT /cachegroups' instead"
- }
- ],
- "response": [
- {
- "cacheGroupId": 7,
- "fallbackOrder": 2,
- "fallbackName": "test",
- "fallbackId": 8,
- "cacheGroupName": "CDN_in_a_Box_Edge"
- }
- ]}
-
-``DELETE``
-==========
-Remove one or more :ref:`cache-group-fallbacks` from one or more :term:`Cache Groups`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +--------------+----------+--------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==============+==========+==============================================================================================================+
- | cacheGroupId |yes\ [2]_ | The :ref:`cache-group-id` of a :term:`Cache Group` from which :ref:`cache-group-fallbacks` are being removed |
- +--------------+----------+--------------------------------------------------------------------------------------------------------------+
- | fallbackId |yes\ [2]_ | The :ref:`cache-group-id` of a :ref:`"fallback" <cache-group-fallbacks>` :term:`Cache Group` |
- +--------------+----------+--------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.4/cachegroup_fallbacks?fallbackId=8 HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 0
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 186
- Content-Type: application/json
- Date: Mon, 02 Dec 2019 22:30:58 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Tue, 03 Dec 2019 02:30:58 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: iag1k8Ym4K6nrpahJwzyA45m2RO6159gSRg4ozUvg69/TKrTLyggMeAIVdzbwn8+ayOFq01lTK1Ho9jQFJ5j2w==
-
- { "alerts": [
- {
- "level": "success",
- "text": "Cachegroup 8 DELETED from all the configured fallback lists"
- },
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'PUT /cachegroups with an empty 'fallbacks' array' instead"
- }
- ]}
-
-.. [2] At least one of "cacheGroupId" or "fallbackId" must be sent with the request. If both are sent, a single fallback relationship is deleted, whereas using only "cacheGroupId" will result in all fallbacks being removed from the :term:`Cache Group` identified by that integral, unique identifier, and using only "fallbackId" will remove the :term:`Cache Group` identified by *that* integral, unique identifier from all other :term:`Cache Groups`' fallback lists.
diff --git a/docs/source/api/v1/cachegroup_parameterID_parameter.rst b/docs/source/api/v1/cachegroup_parameterID_parameter.rst
deleted file mode 100644
index 6363074..0000000
--- a/docs/source/api/v1/cachegroup_parameterID_parameter.rst
+++ /dev/null
@@ -1,115 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroup-parameterID-parameter:
-
-*****************************************
-``cachegroup/{{parameter ID}}/parameter``
-*****************************************
-.. deprecated:: ATCv4
-.. danger:: This endpoint does not appear to work, and thus its use is strongly discouraged!
-
-``GET``
-=======
-Extract identifying information about all :term:`Cache Groups` with a specific :term:`Parameter`
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +--------------+----------+-----------------------+
- | Name | Required | Description |
- +==============+==========+=======================+
- | parameter_ID | yes | A :ref:`parameter-id` |
- +--------------+----------+-----------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cachegroup/1/parameter HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cachegroups: An array of all :term:`Cache Groups` with an associated :term:`Parameter` identifiable by the ``parameter_id`` request path parameter
-
- :id: An integer that is the :term:`Cache Group`'s :ref:`cache-group-id`
- :name: A string that is the :ref:`cache-group-name` of the :term:`Cache Group`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 161
- Content-Type: application/json
- Date: Tue, 03 Dec 2019 15:15:26 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Tue, 03 Dec 2019 19:15:26 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: H03AKuJ2IjG3wb6SEplNtIjm8ka3JJdRxc2HyOkNzjHdsh8p7UcJ1teYvYUf8yMNDt8HHBaKzIDoHODLwhktjA==
-
- {
- "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /cachegroupparameters & GET /cachegroups' instead"
- }
- ],
- "response": {
- "cachegroups": [
- {
- "name": "CDN_in_a_Box_Edge",
- "id": 7
- },
- {
- "name": "CDN_in_a_Box_Mid",
- "id": 6
- },
- {
- "name": "TRAFFIC_ANALYTICS",
- "id": 1
- },
- {
- "name": "TRAFFIC_OPS",
- "id": 2
- },
- {
- "name": "TRAFFIC_OPS_DB",
- "id": 3
- },
- {
- "name": "TRAFFIC_PORTAL",
- "id": 4
- },
- {
- "name": "TRAFFIC_STATS",
- "id": 5
- }
- ]
- }}
diff --git a/docs/source/api/v1/cachegroupparameters.rst b/docs/source/api/v1/cachegroupparameters.rst
deleted file mode 100644
index d4710f2..0000000
--- a/docs/source/api/v1/cachegroupparameters.rst
+++ /dev/null
@@ -1,186 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroupparameters:
-
-************************
-``cachegroupparameters``
-************************
-
-``GET``
-=======
-Extract information about the :ref:`cache-group-parameters` associated with :term:`Cache Groups`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Response Structure
-------------------
-.. table:: Request Query Parameters
-
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=============+==========+======================================================================================================================================+
- | cachegroup | no | Show only the :ref:`cache-group-parameters` with the :term:`Cache Group` identified by this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | parameter | no | Show only the :ref:`cache-group-parameters` with the :term:`Parameter` identified by this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` array |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
- | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
-
-Response Structure
-------------------
-:cachegroupParameters: An array of identifying information for the :ref:`cache-group-parameters` of :term:`Cache Groups`
-
- :cachegroup: A string containing the :ref:`cache-group-name` of the :term:`Cache Group`
- :last_updated: Date and time of last modification in :ref:`non-rfc-datetime`
- :parameter: An integer that is the :term:`Parameter`'s :ref:`parameter-id`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 18:24:12 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: PZyh09NeYYy4sXSv+Bfov0v32EuEk/1y7/B+4fyvhbcPxWQ650NXBDpAe8IsmYZQYVRB03xlBtc33bo3Ixunbg==
- Content-Length: 124
-
- { "response": {
- "cachegroupParameters": [
- {
- "parameter": 124,
- "last_updated": "2018-11-14 18:23:40.488853+00",
- "cachegroup": "test"
- }
- ]
- }}
-
-``POST``
-========
-Assign :term:`Parameter`\ (s) to :term:`Cache Group`\ (s).
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Array
-
-Request Structure
------------------
-This endpoint accepts two formats for the request payload:
-
-Single Object Format
- For assigning a single :term:`Parameter` to a single :term:`Cache Group`
-Array Format
- For making multiple assignments of :term:`Parameters` to :term:`Cache Groups` simultaneously
-
-Single Object Format
-""""""""""""""""""""
-
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` to which a :term:`Parameter` is being assigned
-:parameterId: An integer that is the :ref:`parameter-id` of the :term:`Parameter` being assigned
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.1/cachegroupparameters HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 39
- Content-Type: application/json
-
- {
- "cacheGroupId": 8,
- "parameterId": 124
- }
-
-Array Format
-""""""""""""
-
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` to which a :term:`Parameter` is being assigned
-:parameterId: An integer that is the :ref:`parameter-id` of the :term:`Parameter` being assigned
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.1/cachegroupparameters HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 39
- Content-Type: application/json
-
- [{
- "cacheGroupId": 8,
- "parameterId": 124
- },
- {
- "cacheGroupId": 8,
- "parameterId": 125
- }]
-
-Response Structure
-------------------
-:cacheGroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` to which a :term:`Parameter` has been assigned
-:parameterId: An integer that is the :ref:`parameter-id` of the :term:`Parameter` which has been assigned
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 15:47:49 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: wCv388wFaSjgFLCnI9dchlcyGxaVr8IhBAG25F+rpI2/azCswEYTcVBSlYOg6NxTQRzGkluMvn67jI6rV+vNsQ==
- Content-Length: 136
-
- { "alerts": [
- {
- "level": "success",
- "text": "Cachegroup parameter associations were created."
- }
- ],
- "response": [
- {
- "cacheGroupId": 8,
- "parameterId": 124
- }
- ]}
diff --git a/docs/source/api/v1/cachegroupparameters_id_parameterID.rst b/docs/source/api/v1/cachegroupparameters_id_parameterID.rst
deleted file mode 100644
index 5753501..0000000
--- a/docs/source/api/v1/cachegroupparameters_id_parameterID.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroupparameters-id-parameterID:
-
-***********************************************
-``cachegroupparameters/{{ID}}/{{parameterID}}``
-***********************************************
-
-``DELETE``
-==========
-Dissociate a :term:`Parameter` with a :term:`Cache Group`
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-------------+----------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +=============+================================================================================================================+
- | ID | The :ref:`cache-group-id` of the :term:`Cache Group` which will have the :term:`Parameter` association deleted |
- +-------------+----------------------------------------------------------------------------------------------------------------+
- | parameterID | The :ref:`parameter-id` of the :term:`Parameter` which will be removed from a :term:`Cache Group` |
- +-------------+----------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.1/cachegroupparameters/8/124 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 18:26:40 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: Cuj+ZPAKsDLp4FpbJDcwsWY0yVQAi1Um1CWraeTIQEMlyJSBEm17oKQWDjzTrvqqV8Prhu3gzlcHoVPzEpbQ1Q==
- Content-Length: 84
-
- { "alerts": [
- {
- "level": "success",
- "text": "cachegroup parameter was deleted."
- }
- ]}
diff --git a/docs/source/api/v1/cachegroups.rst b/docs/source/api/v1/cachegroups.rst
deleted file mode 100644
index 49f9ce0..0000000
--- a/docs/source/api/v1/cachegroups.rst
+++ /dev/null
@@ -1,265 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups:
-
-***************
-``cachegroups``
-***************
-
-``GET``
-=======
-Extract information about :term:`Cache Groups`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +===========+==========+==========================================================================================================================+
- | id | no | Return the only :term:`Cache Group` that has this id |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only :term:`Cache Groups` that are of the :ref:`cache-group-type` identified by this integral, unique identifier |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` array |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the |
- | | | first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of |
- | | | ``page``. |
- +-----------+----------+--------------------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.3/cachegroups?type=23 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-
-Response Structure
-------------------
-:fallbacks: An array of strings that are :ref:`Cache Group names <cache-group-name>` that are registered as :ref:`cache-group-fallbacks` for this :term:`Cache Group`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:fallbackToClosest: A boolean value that defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`\ [#fallbacks]_
-:id: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group`
-:lastUpdated: The time and date at which this entry was last updated in :ref:`non-rfc-datetime`
-:latitude: A floating-point :ref:`cache-group-latitude` for the :term:`Cache Group`
-:localizationMethods: An array of :ref:`cache-group-localization-methods` as strings
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:longitude: A floating-point :ref:`cache-group-longitude` for the :term:`Cache Group`
-:name: A string containing the :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:parentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:secondaryParentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:secondaryParentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` :term:`Cache Group` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:shortName: A string containing the :ref:`cache-group-short-name` of the :term:`Cache Group`
-:typeId: An integral, unique identifier for the ':term:`Type`' of the :term:`Cache Group`
-:typeName: A string that names the :ref:`cache-group-type` of this :term:`Cache Group`
-
-.. note:: The default value of ``fallbackToClosest`` is 'true', and if it is 'null' Traffic Control components will still interpret it as 'true'.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: oV6ifEgoFy+v049tVjSsRdWQf4bxjrUvIYfDdgpUtlxiC7gzCv31m5bXQ8EUBW4eg2hfYM+BsGvJpnNDZB7pUg==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 07 Nov 2018 19:46:36 GMT
- Content-Length: 379
-
- { "response": [
- {
- "id": 7,
- "name": "CDN_in_a_Box_Edge",
- "shortName": "ciabEdge",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "parentCachegroupName": "CDN_in_a_Box_Mid",
- "parentCachegroupId": 6,
- "secondaryParentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "fallbackToClosest": [],
- "localizationMethods": [],
- "typeName": "EDGE_LOC",
- "typeId": 23,
- "lastUpdated": "2018-11-07 14:45:43+00",
- "fallbacks": []
- }
- ]}
-
-
-``POST``
-========
-Creates a :term:`Cache Group`
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:fallbacks: An optional field which, when present, should contain an array of strings that are the :ref:`Names <cache-group-name>` of other :term:`Cache Groups` which will be the :ref:`cache-group-fallbacks`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- Support for this field was added to all versions of this endpoint with Apache Traffic Control version 4.0
-
-:fallbackToClosest: A boolean that sets the :ref:`cache-group-fallback-to-closest` behavior of the :term:`Cache Group`\ [#fallbacks]_
-
- .. note:: The default value of ``fallbackToClosest`` is ``true``, and if it is ``null`` Traffic Control components will still interpret it as though it were ``true``.
-
-:latitude: An optional field which, if present, should be a floating-point number that will define the :ref:`cache-group-latitude` for the :term:`Cache Group`\ [#optional]_
-:localizationMethods: Array of :ref:`cache-group-localization-methods` (as strings)
-
- .. versionadded:: ATCv4.0
-
- Support for this field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- .. tip:: This field has no defined meaning if the :ref:`cache-group-type` identified by ``typeId`` is not "EDGE_LOC".
-
-:longitude: An optional field which, if present, should be a floating-point number that will define the :ref:`cache-group-longitude` for the :term:`Cache Group`\ [#optional]_
-:name: The :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An optional field which, if present, should be an integer that is the :ref:`cache-group-id` of a :ref:`cache-group-parent` for this :term:`Cache Group`.
-:secondaryParentCachegroupId: An optional field which, if present, should be an integral, unique identifier for this :term:`Cache Group`'s secondary parent
-:shortName: An abbreviation of the ``name``
-:typeId: An integral, unique identifier for the :ref:`Cache Group's Type <cache-group-type>`
-
- .. note:: The actual, integral, unique identifiers for these :term:`Types` must first be obtained, generally via :ref:`to-api-v1-types`.
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.1/cachegroups HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 252
- Content-Type: application/json
-
- {
- "name": "test",
- "shortName": "test",
- "latitude": 0,
- "longitude": 0,
- "fallbackToClosest": true,
- "localizationMethods": [
- "DEEP_CZ",
- "CZ",
- "GEO"
- ],
- "typeId": 23,
- }
-
-Response Structure
-------------------
-:fallbacks: An array of strings that are :ref:`Cache Group names <cache-group-name>` that are registered as :ref:`cache-group-fallbacks` for this :term:`Cache Group`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:fallbackToClosest: A boolean value that defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`\ [#fallbacks]_
-:id: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group`
-:lastUpdated: The time and date at which this entry was last updated in :ref:`non-rfc-datetime`
-:latitude: A floating-point :ref:`cache-group-latitude` for the :term:`Cache Group`
-:localizationMethods: An array of :ref:`cache-group-localization-methods` as strings
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:longitude: A floating-point :ref:`cache-group-longitude` for the :term:`Cache Group`
-:name: A string containing the :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:parentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:secondaryParentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:secondaryParentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` :term:`Cache Group` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:shortName: A string containing the :ref:`cache-group-short-name` of the :term:`Cache Group`
-:typeId: An integral, unique identifier for the ':term:`Type`' of the :term:`Cache Group`
-:typeName: A string that names the :ref:`cache-group-type` of this :term:`Cache Group`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: YvZlh3rpfl3nBq6SbNVhbkt3IvckbB9amqGW2JhLxWK9K3cxjBq5J2sIHBUhrLKUhE9afpxtvaYrLRxjt1/YMQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 07 Nov 2018 22:11:50 GMT
- Content-Length: 379
-
- { "alerts": [
- {
- "text": "cachegroup was created.",
- "level": "success"
- }
- ],
- "response": {
- "id": 8,
- "name": "test",
- "shortName": "test",
- "latitude": 0,
- "longitude": 0,
- "parentCachegroupName": null,
- "parentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "fallbackToClosest": true,
- "localizationMethods": [
- "DEEP_CZ",
- "CZ",
- "GEO"
- ],
- "typeName": "EDGE_LOC",
- "typeId": 23,
- "lastUpdated": "2019-12-02 22:21:08+00",
- "fallbacks": []
- }}
-
-.. [#fallbacks] Traffic Router will first check for a ``fallbacks`` array and, when that is empty/unset/all the :term:`Cache Groups` in it are also unavailable, will subsequently check for ``fallbackToClosest``. If that is ``true``, then it falls back to the geographically closest :term:`Cache Group` capable of serving the same content or, when it is ``false``/no such :term:`Cache Group` exists/said :term:`Cache Group` is also unavailable, will respond to clients with a failure response [...]
-.. [#optional] While these fields are technically optional, note that if they are not specified many things may break. For this reason, Traffic Portal requires them when creating or editing :term:`Cache Groups`.
diff --git a/docs/source/api/v1/cachegroups_id.rst b/docs/source/api/v1/cachegroups_id.rst
deleted file mode 100644
index ee0148a..0000000
--- a/docs/source/api/v1/cachegroups_id.rst
+++ /dev/null
@@ -1,326 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-id:
-
-**********************
-``cachegroups/{{ID}}``
-**********************
-Extracts information about a single :term:`Cache Group`
-
-``GET``
-=======
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cachegroups` with the query parameter ``id`` instead.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +===========+==========+===============================================================================================================+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | | array |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | | defined to make use of ``page``. |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
-
-.. table:: Request Path Parameters
-
- +--------------+----------------------------------------------------+
- | Parameter | Description |
- +==============+====================================================+
- | ID | The :ref:`cache-group-id` of a :term:`Cache Group` |
- +--------------+----------------------------------------------------+
-
-Response Structure
-------------------
-:fallbacks: An array of strings that are :ref:`Cache Group names <cache-group-name>` that are registered as :ref:`cache-group-fallbacks` for this :term:`Cache Group`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:fallbackToClosest: A boolean value that defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`\ [#fallbacks]_
-:id: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group`
-:lastUpdated: The time and date at which this entry was last updated in :ref:`non-rfc-datetime`
-:latitude: A floating-point :ref:`cache-group-latitude` for the :term:`Cache Group`
-:localizationMethods: An array of :ref:`cache-group-localization-methods` as strings
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:longitude: A floating-point :ref:`cache-group-longitude` for the :term:`Cache Group`
-:name: A string containing the :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:parentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:secondaryParentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:secondaryParentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` :term:`Cache Group` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:shortName: A string containing the :ref:`cache-group-short-name` of the :term:`Cache Group`
-:typeId: An integral, unique identifier for the ':term:`Type`' of the :term:`Cache Group`
-:typeName: A string that names the :ref:`cache-group-type` of this :term:`Cache Group`
-
-.. note:: The default value of ``fallbackToClosest`` is 'true', and if it is 'null' Traffic Control components will still interpret it as 'true'.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: EXO+TK1CIwQ5lzTXQGqlLDzU641pLLCQbyqz5Z8QUYSPAjjn5cqC9W3c0ioDiCdK9bUWvHP3E4/ERBzkBTi06g==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 18:35:53 GMT
- Content-Length: 357
-
- { "response": [
- {
- "id": 8,
- "name": "test",
- "shortName": "test",
- "latitude": 0,
- "longitude": 0,
- "parentCachegroupName": "CDN_in_a_Box_Mid",
- "parentCachegroupId": 6,
- "secondaryParentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "fallbackToClosest": true,
- "localizationMethods": [
- "DEEP_CZ",
- "CZ"
- ],
- "typeName": "EDGE_LOC",
- "typeId": 23,
- "lastUpdated": "2018-11-14 18:23:33+00",
- "fallbacks": []
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cachegroups with query parameter id instead",
- "level": "warning"
- }
- ]}
-
-
-``PUT``
-=======
-Update :term:`Cache Group`
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-----------+----------------------------------------------------+
- | Parameter | Description |
- +===========+====================================================+
- | ID | The :ref:`cache-group-id` of a :term:`Cache Group` |
- +-----------+----------------------------------------------------+
-
-:fallbacks: An optional field which, when present, should contain an array of strings that are the :ref:`Names <cache-group-name>` of other :term:`Cache Groups` which will be the :ref:`cache-group-fallbacks`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- Support for this field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
-:fallbackToClosest: A boolean that sets the :ref:`cache-group-fallback-to-closest` behavior of the :term:`Cache Group`\ [#fallbacks]_
-
- .. note:: The default value of ``fallbackToClosest`` is ``true``, and if it is ``null`` Traffic Control components will still interpret it as though it were ``true``.
-
-:latitude: An optional field which, if present, should be a floating-point number that will define the :ref:`cache-group-latitude` for the :term:`Cache Group`\ [#optional]_
-:localizationMethods: Array of :ref:`cache-group-localization-methods` (as strings)
-
- .. versionadded:: ATCv4.0
-
- Support for this field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- .. tip:: This field has no defined meaning if the :ref:`cache-group-type` identified by ``typeId`` is not "EDGE_LOC".
-
-:longitude: An optional field which, if present, should be a floating-point number that will define the :ref:`cache-group-longitude` for the :term:`Cache Group`\ [#optional]_
-:name: The :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An optional field which, if present, should be an integer that is the :ref:`cache-group-id` of a :ref:`cache-group-parent` for this :term:`Cache Group`.
-:secondaryParentCachegroupId: An optional field which, if present, should be an integral, unique identifier for this :term:`Cache Group`'s secondary parent
-:shortName: An abbreviation of the ``name``
-:typeId: An integral, unique identifier for the :ref:`Cache Group's Type <cache-group-type>`
-
- .. note:: The actual, integral, unique identifiers for these :term:`Types` must first be obtained, generally via :ref:`to-api-v1-types`.
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.3/cachegroups/8 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 118
- Content-Type: application/json
-
- {
- "latitude": 0.0,
- "longitude": 0.0,
- "name": "test",
- "fallbacks": [],
- "fallbackToClosest": true,
- "shortName": "test",
- "typeId": 23,
- "localizationMethods": ["GEO"]
- }
-
-Response Structure
-------------------
-:fallbacks: An array of strings that are :ref:`Cache Group names <cache-group-name>` that are registered as :ref:`cache-group-fallbacks` for this :term:`Cache Group`\ [#fallbacks]_
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:fallbackToClosest: A boolean value that defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`\ [#fallbacks]_
-:id: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group`
-:lastUpdated: The time and date at which this entry was last updated in :ref:`non-rfc-datetime`
-:latitude: A floating-point :ref:`cache-group-latitude` for the :term:`Cache Group`
-:localizationMethods: An array of :ref:`cache-group-localization-methods` as strings
-
- .. versionadded:: ATCv4.0
-
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0
-
-:longitude: A floating-point :ref:`cache-group-longitude` for the :term:`Cache Group`
-:name: A string containing the :ref:`cache-group-name` of the :term:`Cache Group`
-:parentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:parentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-parent` - or ``null`` if it doesn't have a :ref:`cache-group-parent`
-:secondaryParentCachegroupId: An integer that is the :ref:`cache-group-id` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:secondaryParentCachegroupName: A string containing the :ref:`cache-group-name` of this :term:`Cache Group`'s :ref:`cache-group-secondary-parent` :term:`Cache Group` - or ``null`` if it doesn't have a :ref:`cache-group-secondary-parent`
-:shortName: A string containing the :ref:`cache-group-short-name` of the :term:`Cache Group`
-:typeId: An integral, unique identifier for the ':term:`Type`' of the :term:`Cache Group`
-:typeName: A string that names the :ref:`cache-group-type` of this :term:`Cache Group`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: t1W65/2kj25QyHt0Ib0xpBaAR2sXu2kOsRZ49WjKZp/AK5S1YWhX7VNWCuUGiN1VNM4QRNqODC/7ewhYDFUncA==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 19:14:28 GMT
- Content-Length: 385
-
- { "alerts": [
- {
- "text": "cachegroup was updated.",
- "level": "success"
- }
- ],
- "response": {
- "id": 8,
- "name": "test",
- "shortName": "test",
- "latitude": 0,
- "longitude": 0,
- "parentCachegroupName": null,
- "parentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "fallbacks": [],
- "fallbackToClosest": true,
- "localizationMethods": [
- "GEO"
- ],
- "typeName": "EDGE_LOC",
- "typeId": 23,
- "lastUpdated": "2018-11-14 19:14:28+00"
- }}
-
-
-``DELETE``
-==========
-Delete a :term:`Cache Group`. A :term:`Cache Group` which has assigned servers or is the :ref:`cache-group-parent` of one or more other :term:`Cache Groups` cannot be deleted.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-----------+------------------------------------------------------------------+
- | Parameter | Description |
- +===========+==================================================================+
- | ID | The :ref:`cache-group-id` of a :term:`Cache Group` to be deleted |
- +-----------+------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.4/cachegroups/42 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 5jZBgO7h1eNF70J/cmlbi3Hf9KJPx+WLMblH/pSKF3FWb/10GUHIN35ZOB+lN5LZYCkmk3izGbTFkiruG8I41Q==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:31:04 GMT
- Content-Length: 57
-
- { "alerts": [
- {
- "text": "cachegroup was deleted.",
- "level": "success"
- }
- ]}
-
-.. [#fallbacks] Traffic Router will first check for a ``fallbacks`` array and, when that is empty/unset/all the :term:`Cache Groups` in it are also unavailable, will subsequently check for ``fallbackToClosest``. If that is ``true``, then it falls back to the geographically closest :term:`Cache Group` capable of serving the same content or, when it is ``false``/no such :term:`Cache Group` exists/said :term:`Cache Group` is also unavailable, will respond to clients with a failure response [...]
-.. [#optional] While these fields are technically optional, note that if they are not specified many things may break. For this reason, Traffic Portal requires them when creating or editing :term:`Cache Groups`.
diff --git a/docs/source/api/v1/cachegroups_id_deliveryservices.rst b/docs/source/api/v1/cachegroups_id_deliveryservices.rst
deleted file mode 100644
index d049614..0000000
--- a/docs/source/api/v1/cachegroups_id_deliveryservices.rst
+++ /dev/null
@@ -1,93 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-id-deliveryservices:
-
-***************************************
-``cachegroups/{{ID}}/deliveryservices``
-***************************************
-
-``POST``
-========
-Assigns all of the "assignable" servers within a :term:`Cache Group` to one or more :term:`Delivery Services`.
-
-.. note:: "Assignable" here means all of the :ref:`Cache Group's servers <cache-group-servers>` that have a :term:`Type` that matches one of the glob patterns ``EDGE*`` or ``ORG*``. If even one server of any :term:`Type` exists within the :term:`Cache Group` that is not assigned to the same CDN as the :term:`Delivery Service` to which an attempt is being made to assign them, the request will fail.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table::Request Path Parameters
-
- +------+-----------------------------------------------------------------------------------+
- | Name | Description |
- +======+===================================================================================+
- | ID | The :ref:`cache-group-id` of the :term:`Cache Group` from which to assign servers |
- +------+-----------------------------------------------------------------------------------+
-
-:deliveryServices: The integral, unique identifiers of the :term:`Delivery Services` to which the :ref:`Cache Group's servers <cache-group-servers>` are being assigned
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.3/cachegroups/8/deliveryservices HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 25
- Content-Type: application/json
-
- {"deliveryServices": [2]}
-
-Response Structure
-------------------
-:deliveryServices: An array of integral, unique identifiers for :term:`Delivery Services` to which the :ref:`Cache Group's servers <cache-group-servers>` have been assigned
-:id: An integer that is the :ref:`Cache Group's ID <cache-group-id>`
-:serverNames: An array of the (short) hostnames of all of the :term:`Cache Group`'s "assignable" :ref:`cache-group-servers`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: j/yH0gvJoaGjiLZU/0MA8o5He20O4aJ5wh1eF9ex6F6IBO1liM9Wk9RkWCw7sdiUHoy13/mf7gDntisZwzP7yw==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 19:54:17 GMT
- Content-Length: 183
-
- { "alerts": [
- {
- "text": "Delivery services successfully assigned to all the servers of cache group 8.",
- "level": "success"
- }
- ],
- "response": {
- "id": 8,
- "serverNames": [
- "foo"
- ],
- "deliveryServices": [
- 2
- ]
- }}
-
diff --git a/docs/source/api/v1/cachegroups_id_parameters.rst b/docs/source/api/v1/cachegroups_id_parameters.rst
deleted file mode 100644
index 224a719..0000000
--- a/docs/source/api/v1/cachegroups_id_parameters.rst
+++ /dev/null
@@ -1,97 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-id-parameters:
-
-*********************************
-``cachegroups/{{ID}}/parameters``
-*********************************
-
-``GET``
-=======
-Gets all of a :ref:`Cache Group's parameters <cache-group-parameters>`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=============+==========+===============================================================================================================+
- | parameterId | no | Show only the :term:`Parameter` with the given :ref:`parameter-id` |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | | array |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | | defined to make use of ``page``. |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
-
-.. table:: Request Path Parameters
-
- +-----------+----------------------------------------------------------+
- | Parameter | Description |
- +===========+==========================================================+
- | ID | The :ref:`cache-group-id` of a :term:`Cache Group` |
- +-----------+----------------------------------------------------------+
-
-
-Response Structure
-------------------
-:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
-:id: The :term:`Parameter`'s :ref:`parameter-id`
-:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in :ref:`non-rfc-datetime`
-:name: :ref:`parameter-name` of the :term:`Parameter`
-:secure: A boolean value describing whether or not the :term:`Parameter` is :ref:`parameter-secure`
-:value: The :term:`Parameter`'s :ref:`parameter-value`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 19:56:23 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: DfqPtySzVMpnBYqVt/45sSRG/1pRTlQdIcYuQZ0CQt79QSHLzU5e4TbDqht6ntvNP041LimKsj5RzPlPX1n6tg==
- Content-Length: 135
-
- { "response": [
- {
- "lastUpdated": "2018-11-14 18:22:43.754786+00",
- "value": "foobar",
- "secure": false,
- "name": "foo",
- "id": 124,
- "configFile": "bar"
- }
- ]}
diff --git a/docs/source/api/v1/cachegroups_id_queue_update.rst b/docs/source/api/v1/cachegroups_id_queue_update.rst
deleted file mode 100644
index cdb8050..0000000
--- a/docs/source/api/v1/cachegroups_id_queue_update.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-id-queue_update:
-
-***********************************
-``cachegroups/{{ID}}/queue_update``
-***********************************
-
-``POST``
-========
-:term:`Queue` or "dequeue" updates for all of a :ref:`Cache Group's servers <cache-group-servers>`, limited to a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +======+============================================================================================================+
- | ID | The :ref:`cache-group-id` of the :term:`Cache Group` for which updates are being :term:`Queue`\ d/dequeued |
- +------+------------------------------------------------------------------------------------------------------------+
-
-:action: The action to perform; one of "queue" or "dequeue"
-:cdn: The full name of the CDN in need of :term:`Queue Updates`, or a "dequeue" thereof\ [#required]_
-:cdnId: The integral, unique identifier for the CDN in need of :term:`Queue Updates`, or a "dequeue" thereof\ [#required]_
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.3/cachegroups/8/queue_update HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 42
- Content-Type: application/json
-
- {"action": "queue", "cdn": "CDN-in-a-Box"}
-
-
-Response Structure
-------------------
-:action: The action processed, one of "queue" or "dequeue"
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` for which :term:`Queue Updates` was performed or cleared
-:cachegroupName: The name of the :term:`Cache Group` for which updates were queued/dequeued
-:cdn: The name of the CDN to which the queue/dequeue operation was restricted
-:serverNames: An array of the (short) hostnames of the :ref:`Cache Group's servers <cache-group-servers>` which are also assigned to the CDN specified in the ``"cdn"`` field
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: UAcP7LrflU1RnfR4UqbQrJczlk5rkrcLOtTXJTFvIUXxK1EklZkHkE4vewjDaVIhJJ6YQg8jmPGQpr+x1RHabw==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:19:46 GMT
- Content-Length: 115
-
- { "response": {
- "cachegroupName": "test",
- "action": "queue",
- "serverNames": [
- "foo"
- ],
- "cdn": "CDN-in-a-Box",
- "cachegroupID": 8
- }}
-
-.. [#required] Either 'cdn' or 'cdnID' *must* be in the request data (but not both).
diff --git a/docs/source/api/v1/cachegroups_id_unassigned_parameters.rst b/docs/source/api/v1/cachegroups_id_unassigned_parameters.rst
deleted file mode 100644
index a5407c7..0000000
--- a/docs/source/api/v1/cachegroups_id_unassigned_parameters.rst
+++ /dev/null
@@ -1,115 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-id-unassigned_parameters:
-
-********************************************
-``cachegroups/{{id}}/unassigned_parameters``
-********************************************
-.. deprecated:: ATCv4
- This endpoint and all of its functionality is deprecated. All of the information it can return can be obtained using :ref:`to-api-v1-cachegroupparameters` & :ref:`to-api-v1-parameters`.
-
-``GET``
-=======
-Gets all the :term:`Parameters` that are *not* a specific :ref:`Cache Group's parameters <cache-group-parameters>`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=============+==========+===============================================================================================================+
- | parameterId | no | Show only the :term:`Parameter` with the given ID |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | | array |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | | defined to make use of ``page``. |
- +-------------+----------+---------------------------------------------------------------------------------------------------------------+
-
-.. table:: Request Path Parameters
-
- +--------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +========+==========+====================================================+
- | ``id`` | yes | The :ref:`cache-group-id` of a :term:`Cache Group` |
- +--------+----------+----------------------------------------------------+
-
-
-Response Structure
-------------------
-:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
-:id: The :term:`Parameter`'s :ref:`parameter-id`
-:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in :ref:`non-rfc-datetime`
-:name: :ref:`parameter-name` of the :term:`Parameter`
-:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
-:value: The :term:`Parameter`'s :ref:`parameter-value`
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": [
- {
- "lastUpdated": "2018-10-09 11:14:33.862905+00",
- "value": "/opt/trafficserver/etc/trafficserver",
- "secure": false,
- "name": "location",
- "id": 6836,
- "configFile": "hdr_rw_bamtech-nhl-live.config"
- },
- {
- "lastUpdated": "2018-10-09 11:14:33.862905+00",
- "value": "/opt/trafficserver/etc/trafficserver",
- "secure": false,
- "name": "location",
- "id": 6837,
- "configFile": "hdr_rw_mid_bamtech-nhl-live.config"
- },
- {
- "lastUpdated": "2018-10-09 11:55:46.014844+00",
- "value": "/opt/trafficserver/etc/trafficserver",
- "secure": false,
- "name": "location",
- "id": 6842,
- "configFile": "hdr_rw_bamtech-nhl-live-t.config"
- },
- {
- "lastUpdated": "2018-10-09 11:55:46.014844+00",
- "value": "/opt/trafficserver/etc/trafficserver",
- "secure": false,
- "name": "location",
- "id": 6843,
- "configFile": "hdr_rw_mid_bamtech-nhl-live-t.config"
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cachegroupparameters & GET /parameters instead",
- "level": "warning"
- }
- ]}
diff --git a/docs/source/api/v1/cachegroups_parameterID_parameter_available.rst b/docs/source/api/v1/cachegroups_parameterID_parameter_available.rst
deleted file mode 100644
index c918caf..0000000
--- a/docs/source/api/v1/cachegroups_parameterID_parameter_available.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-parameterID-parameter-available:
-
-****************************************************
-``cachegroups/{{parameter ID}}/parameter/available``
-****************************************************
-.. deprecated:: ATCv4
-.. danger:: This endpoint does not appear to work, and thus its use is strongly discouraged!
-
-``GET``
-=======
-Gets a list of :term:`Cache Groups` which are available to have a specific :term:`Parameter` assigned to them.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------------------+----------+--------------------------------------------------------------+
- | Name | Required | Description |
- +==================+==========+==============================================================+
- | ``parameter ID`` | yes | The :ref:`parameter-id` of the :term:`Parameter` of interest |
- +------------------+----------+--------------------------------------------------------------+
-
-Response Structure
-------------------
-:id: An integer that is the :ref:`Cache Group's ID <cache-group-id>`
-:name: A string that is the :ref:`Cache Group's name <cache-group-name>`
-
-.. code-block:: json
- :caption: Response Example
-
- {
- "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /cachegroupparameters & GET /cachegroups' instead"
- }
- ],
- "response": [
- {
- "name": "dc-chicago",
- "id": "21"
- },
- {
- "name": "dc-cmc",
- "id": "22"
- }
- ]}
diff --git a/docs/source/api/v1/cachegroups_trimmed.rst b/docs/source/api/v1/cachegroups_trimmed.rst
deleted file mode 100644
index 9a59a49..0000000
--- a/docs/source/api/v1/cachegroups_trimmed.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cachegroups-trimmed:
-
-***********************
-``cachegroups/trimmed``
-***********************
-.. deprecated:: ATCv4
- This endpoint and all of its functionality is deprecated. All of the information it can return can be more completely obtained with :ref:`to-api-v1-cachegroups`.
-
-Extract just the :ref:`Names <cache-group-name>` of all :term:`Cache Groups`.
-
-``GET``
-=======
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-No parameters available
-
-Response Structure
-------------------
-:name: A string that is a :ref:`Cache Group's Name <cache-group-name>`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: OyOKqpB24AMlrENIEoA4la/3rclnuKMayvzskmPNPXrDMQksGt0UjVwORYmMdmIS5dQHuIlglBlksvLtqjziHQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:23:23 GMT
- Content-Length: 216
-
- { "response": [
- {
- "name": "TRAFFIC_ANALYTICS"
- },
- {
- "name": "TRAFFIC_OPS"
- },
- {
- "name": "TRAFFIC_OPS_DB"
- },
- {
- "name": "TRAFFIC_PORTAL"
- },
- {
- "name": "TRAFFIC_STATS"
- },
- {
- "name": "CDN_in_a_Box_Mid"
- },
- {
- "name": "CDN_in_a_Box_Edge"
- },
- {
- "name": "test"
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use '/cachegroups' instead",
- "level": "warning"
- }
- ]}
-
diff --git a/docs/source/api/v1/caches_stats.rst b/docs/source/api/v1/caches_stats.rst
deleted file mode 100644
index 0cf677a..0000000
--- a/docs/source/api/v1/caches_stats.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v1-caches-stats:
-
-****************
-``caches/stats``
-****************
-An API endpoint that returns cache statistics using the :ref:`tm-api`.
-
-.. seealso:: This gives a set of basic statistics for *all* :term:`cache servers` at the current time. For statistics from time ranges and/or aggregated over a specific CDN, use :ref:`to-api-v1-cache_stats`.
-
-``GET``
-=======
-Retrieves cache stats from Traffic Monitor. Also includes rows for aggregates.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-No parameters available.
-
-Response Structure
-------------------
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` to which this :term:`cache server` belongs
-:connections: Current number of TCP connections maintained by the :term:`cache server`
-:healthy: ``true`` if Traffic Monitor has marked the :term:`cache server` as "healthy", ``false`` otherwise
-
- .. seealso:: :ref:`health-proto`
-
-:hostname: The (short) hostname of the :term:`cache server`
-:ip: The IP address of the :term:`cache server`
-:kbps: The :term:`cache server`'s upload speed (to clients) in Kilobits per second
-:profile: The :ref:`profile-name` of the :term:`Profile` in use by this :term:`cache server`
-:status: The status of the :term:`cache server`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 20:25:01 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: DqbLgitanS8q81/qKC1i+ImMiEMF+SW4G9rb79FWdeWcgwFjL810tlTRp1nNNfHV+tajgjyK+wMHobqVyaNEfA==
- Content-Length: 133
-
- { "response": [
- {
- "profile": "ALL",
- "connections": 0,
- "ip": null,
- "status": "ALL",
- "healthy": true,
- "kbps": 0,
- "hostname": "ALL",
- "cachegroup": "ALL"
- }
- ]}
diff --git a/docs/source/api/v1/capabilities.rst b/docs/source/api/v1/capabilities.rst
deleted file mode 100644
index b48d24b..0000000
--- a/docs/source/api/v1/capabilities.rst
+++ /dev/null
@@ -1,158 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-capabilities:
-
-****************
-``capabilities``
-****************
-
-``GET``
-=======
-Get all capabilities.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=====================================================================================================================+
- | name | no | Return only the capability that has this name |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` array |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with ``limit`` |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the |
- | | | first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make |
- | | | use of ``page``. |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------------+
-
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/capabilities?name=test HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:name: Name of the capability
-:description: Describes the permissions covered by the capability.
-:lastUpdated: Date and time of the last update made to this capability, in :ref:`non-rfc-datetime`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Vary: Accept-Encoding
- Transfer-Encoding: chunked
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: c18+GtX2ZI8PoCSwuAzBhl+6w3vDpKQTa/cDJC0WHxdpguOL378KBxGWW5PCSyZfJUb7wPyOL5qKMn6NNTufhg==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 15 Aug 2019 17:20:20 GMT
- Content-Length: 161
-
- { "response": [
- {
- "description": "This is only a test. If this were a real capability, it might do something",
- "lastUpdated": "2019-08-15 17:18:03+00",
- "name": "test"
- }
- ]}
-
-``POST``
-========
-Create a capability.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-
-Request Structure
------------------
-:name: The name of the capability being created
-:description: A description of what the capability allows
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/capabilities HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 73
- Content-Type: application/json
-
- {
- "name": "testquest",
- "description": "A test capability for API examples"
- }
-
-Response Structure
-------------------
-:description: Describes the permissions covered by the capability.
-:lastUpdated: Date and time of the last update made to this capability, in :ref:`non-rfc-datetime`
-:name: Name of the capability
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Tue, 07 Jan 2020 20:06:18 GMT; Max-Age=3600; HttpOnly
- X-Server-Name: traffic_ops_golang/
- Date: Tue, 07 Jan 2020 19:06:18 GMT
- Content-Length: 225
-
- { "alerts": [
- {
- "text": "Capability created.",
- "level": "success"
- },
- {
- "text": "This endpoint is deprecated, and will be removed in the future",
- "level": "warning"
- }
- ],
- "response": {
- "description": "A test capability for API examples",
- "lastUpdated": "2020-01-07 19:06:18+00",
- "name": "testquest"
- }}
diff --git a/docs/source/api/v1/capabilities_name.rst b/docs/source/api/v1/capabilities_name.rst
deleted file mode 100644
index 26851a3..0000000
--- a/docs/source/api/v1/capabilities_name.rst
+++ /dev/null
@@ -1,230 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-capabilities-name:
-
-*************************
-``capabilities/{{name}}``
-*************************
-.. deprecated:: ATCv4
- As of ATC version 4.0, every method of this endpoint is deprecated. See each method for details.
-
-``GET``
-=======
-.. deprecated:: ATCv4
- This method of this endpoint is deprecated, please use the 'name' parameter of a ``GET`` request to :ref:`to-api-v1-capabilities` instead.
-
-Get a capability by name.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------+
- | Name | Description |
- +======+========================================+
- | name | The name of the capability of interest |
- +------+----------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.5/capabilities/testquest HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:description: Describes the APIs covered by the capability
-:lastUpdated: Date and time of the last update made to this capability, in :ref:`non-rfc-datetime`
-:name: Name of the capability
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 221
- Content-Type: application/json
- Date: Wed, 29 Jan 2020 20:49:49 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Thu, 30 Jan 2020 00:49:49 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
-
- { "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /capabilities with the 'name' query parameter' instead"
- }
- ],
- "response": [
- {
- "lastUpdated": "2020-01-29 20:10:53.821978+00",
- "name": "testquest",
- "description": "A test capability for API examples"
- }
- ]}
-
-
-``PUT``
-=======
-.. deprecated:: ATCv4
- This method of this endpoint is deprecated. In the future, Capabilities will be immutable, and so no alternative is offered.
-
-Edit a capability.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+-------------------------------------------+
- | Name | Description |
- +======+===========================================+
- | name | The name of the capability to be modified |
- +------+-------------------------------------------+
-
-:description: Describes the APIs covered by the capability
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.5/capabilities/testquest HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 36
-
- {"description": "A new description"}
-
-Response Structure
-------------------
-:description: Describes the APIs covered by the capability.
-:lastUpdated: Date and time of the last update made to this capability, in :ref:`non-rfc-datetime`
-:name: The name of the capability
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 224
- Content-Type: application/json
- Date: Wed, 29 Jan 2020 21:25:10 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Thu, 30 Jan 2020 01:25:10 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
-
- { "alerts": [
- {
- "level": "success",
- "text": "Capability was updated."
- },
- {
- "level": "warning",
- "text": "This endpoint and its functionality is deprecated, and will be removed in the future"
- }
- ],
- "response": {
- "lastUpdated": "2020-01-29 21:24:56.361518+00",
- "name": "testquest",
- "description": "A new description"
- }}
-
-
-``DELETE``
-==========
-.. deprecated:: ATCv4
- This method of this endpoint is deprecated. In the future, Capabilities will be immutable, and so no alternative is offered.
-
-Delete a capability.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters**
-
- +-----------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+================================================+
- | ``name`` | yes | Capability name. |
- +-----------------+----------+------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.5/capabilities/testquest HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
- Content-Length: 0
-
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 146
- Content-Type: application/json
- Date: Wed, 29 Jan 2020 21:27:57 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Thu, 30 Jan 2020 01:27:57 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
-
- { "alerts": [
- {
- "level": "success",
- "text": "Capability deleted."
- },
- {
- "level": "warning",
- "text": "This endpoint and its functionality is deprecated, and will be removed in the future"
- }
- ]}
diff --git a/docs/source/api/v1/cdns.rst b/docs/source/api/v1/cdns.rst
deleted file mode 100644
index 382ec88..0000000
--- a/docs/source/api/v1/cdns.rst
+++ /dev/null
@@ -1,165 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns:
-
-********
-``cdns``
-********
-Extract information about all CDNs
-
-``GET``
-=======
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-
-.. table:: Request Query Parameters
-
- +---------------+----------+-----------------------------------------------------------------------------------+
- | Parameter | Required | Description |
- +===============+==========+===================================================================================+
- | domainName | no | Return only the CDN that has this domain name |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | dnssecEnabled | no | Return only the CDNs that are either dnssec enabled or not |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | id | no | Return only the CDN that has this id |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | name | no | Return only the CDN that has this name |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the |
- | | | objects in the ``response`` array |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending |
- | | | ("desc") |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in |
- | | | conjunction with limit |
- +---------------+----------+-----------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this |
- | | | parameter, pages are ``limit`` long and the first page is 1. If ``offset`` was |
- | | | defined, this query parameter has no effect. ``limit`` must be defined to make |
- | | | use of ``page``. |
- +---------------+----------+-----------------------------------------------------------------------------------+
-
-Response Structure
-------------------
-:dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
-:domainName: Top Level Domain name within which this CDN operates
-:id: The integral, unique identifier for the CDN
-:lastUpdated: Date and time when the CDN was last modified in :ref:`non-rfc-datetime`
-:name: The name of the CDN
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: z9P1NkxGebPncUhaChDHtYKYI+XVZfhE6Y84TuwoASZFIMfISELwADLpvpPTN+wwnzBfREksLYn+0313QoBWhA==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:46:57 GMT
- Content-Length: 237
-
- { "response": [
- {
- "dnssecEnabled": false,
- "domainName": "-",
- "id": 1,
- "lastUpdated": "2018-11-14 18:21:06+00",
- "name": "ALL"
- },
- {
- "dnssecEnabled": false,
- "domainName": "mycdn.ciab.test",
- "id": 2,
- "lastUpdated": "2018-11-14 18:21:14+00",
- "name": "CDN-in-a-Box"
- }
- ]}
-
-
-``POST``
-========
-Allows user to create a CDN
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:dnssecEnabled: If ``true``, this CDN will use DNSSEC, if ``false`` it will not
-:domainName: The top-level domain (TLD) belonging to the new CDN
-:name: Name of the new CDN
-
-.. code-block:: http
- :caption: Request Structure
-
- POST /api/1.4/cdns HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 63
- Content-Type: application/json
-
- {"name": "test", "domainName": "quest", "dnssecEnabled": false}
-
-Response Structure
-------------------
-:dnssecEnabled: ``true`` if the CDN uses DNSSEC, ``false`` otherwise
-:domainName: The top-level domain (TLD) assigned to the newly created CDN
-:id: An integral, unique identifier for the newly created CDN
-:name: The newly created CDN's name
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 1rZRlOfQioGRrEb4nCfjGGx7y3Ub2h7BZ4z6NbhcY4acPslKSUNM8QLjWTVwLU4WpkfJNxcoyy8NlKULFrY9Bg==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:49:28 GMT
- Content-Length: 174
-
- { "alerts": [
- {
- "text": "cdn was created.",
- "level": "success"
- }
- ],
- "response": {
- "dnssecEnabled": false,
- "domainName": "quest",
- "id": 3,
- "lastUpdated": "2018-11-14 20:49:28+00",
- "name": "test"
- }}
diff --git a/docs/source/api/v1/cdns_capacity.rst b/docs/source/api/v1/cdns_capacity.rst
deleted file mode 100644
index 0af8e5c..0000000
--- a/docs/source/api/v1/cdns_capacity.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-capacity:
-
-*****************
-``cdns/capacity``
-*****************
-
-``GET``
-=======
-Retrieves the aggregate capacity percentages of all :term:`Cache Groups` for a given CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-No parameters available.
-
-Response Structure
-------------------
-:availablePercent: The percent of available (unused) bandwidth to 64 bits of precision\ [1]_
-:unavailablePercent: The percent of unavailable (used) bandwidth to 64 bits of precision\ [1]_
-:utilizedPercent: The percent of bandwidth currently in use to 64 bits of precision\ [1]_
-:maintenancePercent: The percent of bandwidth being used for administrative or analytical processes internal to the CDN to 64 bits of precision\ [1]_
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": {
- "availablePercent": 89.0939840205533,
- "unavailablePercent": 0,
- "utilizedPercent": 10.9060020300395,
- "maintenancePercent": 0.0000139494071146245
- }}
-
-.. [1] Following `IEEE 754 <https://ieeexplore.ieee.org/document/4610935>`_
diff --git a/docs/source/api/v1/cdns_configs.rst b/docs/source/api/v1/cdns_configs.rst
deleted file mode 100644
index adcf61c..0000000
--- a/docs/source/api/v1/cdns_configs.rst
+++ /dev/null
@@ -1,71 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-.. _to-api-v1-cdns-config:
-
-****************
-``cdns/configs``
-****************
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cdns` instead.
-.. danger:: This endpoint does not appear to work, and thus its use is strongly discouraged!
-
-``GET``
-=======
-Retrieves CDN configuration information.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-No parameters available.
-
-Response Properties
--------------------
-:id: The integral, unique identifier for this CDN
-:name: The CDN's name
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: z9P1NkxGebPncUhaChDHtYKYI+XVZfhE6Y84TuwoASZFIMfISELwADLpvpPTN+wwnzBfREksLYn+0313QoBWhA==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:46:57 GMT
- Content-Length: 237
-
- { "response": [
- {
- "id": 1,
- "name": "ALL"
- },
- {
- "id": 2,
- "name": "CDN-in-a-Box"
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cdns instead",
- "level": "warning"
- }
- ]}
diff --git a/docs/source/api/v1/cdns_dnsseckeys_refresh.rst b/docs/source/api/v1/cdns_dnsseckeys_refresh.rst
deleted file mode 100644
index 16a05b7..0000000
--- a/docs/source/api/v1/cdns_dnsseckeys_refresh.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-dnsseckeys-refresh:
-
-***************************
-``cdns/dnsseckeys/refresh``
-***************************
-
-``GET``
-=======
-Refresh the DNSSEC keys for all CDNs. This call initiates a background process to refresh outdated keys, and immediately returns a response that the process has started.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object (string)
-
-Request Structure
------------------
-No parameters available
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 21:37:30 GMT
- X-Server-Name: traffic_ops_golang/
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: Uwl+924m6Ye3NraFP+RBpldkhcNTTDyXHZbzRaYV95p9tP56Z61gckeKSr1oQIkNXjXcCsDN5Dmum7Zk1AR6Hw==
- Content-Length: 69
-
- {
- "response": "Checking DNSSEC keys for refresh in the background"
- }
diff --git a/docs/source/api/v1/cdns_domains.rst b/docs/source/api/v1/cdns_domains.rst
deleted file mode 100644
index 49384d9..0000000
--- a/docs/source/api/v1/cdns_domains.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-domains:
-
-****************
-``cdns/domains``
-****************
-
-``GET``
-=======
-Gets a list of domains and their related Traffic Router :term:`Profiles` for all CDNs.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-No parameters available.
-
-Response Structure
-------------------
-:domainName: The :abbr:`TLD (Top-Level Domain)` assigned to this CDN
-:parameterId: The :ref:`parameter-id` for the :term:`Parameter` that sets this :abbr:`TLD (Top-Level Domain)` on the Traffic Router
-:profileDescription: A short, human-readable description of the Traffic Router's profile
-:profileId: The :ref:`profile-id` of the :term:`Profile` assigned to the Traffic Router responsible for serving ``domainName``
-:profileName: The :ref:`profile-name` of the :term:`Profile` assigned to the Traffic Router responsible for serving ``domainName``
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": [
- {
- "profileId": 12,
- "parameterId": -1,
- "profileName": "CCR_CIAB",
- "profileDescription": "Traffic Router for CDN-In-A-Box",
- "domainName": "mycdn.ciab.test"
- }
- ]}
diff --git a/docs/source/api/v1/cdns_health.rst b/docs/source/api/v1/cdns_health.rst
deleted file mode 100644
index 15834dd..0000000
--- a/docs/source/api/v1/cdns_health.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-health:
-
-***************
-``cdns/health``
-***************
-Extract health information from all :term:`Cache Groups` across all CDNs
-
-.. seealso:: :ref:`health-proto`
-
-``GET``
-=======
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-No parameters available
-
-Response Structure
-------------------
-:cachegroups: An array of objects describing the health of each Cache Group
-
- :name: The name of the Cache Group
- :offline: The number of OFFLINE caches in the Cache Group
- :online: The number of ONLINE caches in the Cache Group
-
-:totalOffline: Total number of OFFLINE caches across all Cache Groups which are assigned to any CDN
-:totalOnline: Total number of ONLINE caches across all Cache Groups which are assigned to any CDN
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": {
- "totalOffline": 0,
- "totalOnline": 1,
- "cachegroups": [
- {
- "offline": 0,
- "name": "CDN_in_a_Box_Edge",
- "online": 1
- }
- ]
- }}
diff --git a/docs/source/api/v1/cdns_id.rst b/docs/source/api/v1/cdns_id.rst
deleted file mode 100644
index 515f991..0000000
--- a/docs/source/api/v1/cdns_id.rst
+++ /dev/null
@@ -1,195 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-id:
-
-***************
-``cdns/{{ID}}``
-***************
-
-``GET``
-=======
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cdns` with the query parameter ``id`` instead.
-
-Extract information about a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------------------+
- | Name | Description |
- +======+====================================================+
- | ID | Integral, unique identifier for the CDN to inspect |
- +------+----------------------------------------------------+
-
-Response Structure
-------------------
-:dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
-:domainName: Top Level Domain name within which this CDN operates
-:id: The integral, unique identifier for the CDN
-:lastUpdated: Date and time when the CDN was last modified in :ref:`non-rfc-datetime`
-:name: The name of the CDN
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: bTz86xdnGfbKhxnneb4geXohaw3lhG+h5wc21/ncHFATwp1h80h+txxySCIVfa0hgBrJHEdpGZQsH5w5IknsrQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:59:34 GMT
- Content-Length: 137
-
- { "response": [
- {
- "dnssecEnabled": false,
- "domainName": "mycdn.ciab.test",
- "id": 2,
- "lastUpdated": "2018-11-14 18:21:14+00",
- "name": "CDN-in-a-Box"
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cdns with query parameter id instead",
- "level": "warning"
- }
- ]}
-
-
-``PUT``
-=======
-Allows a user to edit a specific CDN
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+---------------------------------------------------+
- | Name | Description |
- +======+===================================================+
- | ID | Integral, unique identifier for the CDN to update |
- +------+---------------------------------------------------+
-
-:dnssecEnabled: If ``true``, this CDN will use DNSSEC, if ``false`` it will not
-:domainName: The top-level domain (TLD) belonging to the CDN
-:name: Name of the new CDN
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/cdns/3 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 63
- Content-Type: application/json
-
- {"name": "quest", "domainName": "test", "dnssecEnabled": false}
-
-Response Structure
-------------------
-:dnssecEnabled: ``true`` if the CDN uses DNSSEC, ``false`` otherwise
-:domainName: The top-level domain (TLD) assigned to the newly created CDN
-:id: An integral, unique identifier for the newly created CDN
-:name: The newly created CDN's name
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: sI1hzBwG+/VAzoFY20kqGFA2RgrUOThtMeeJqk0ZxH3TRxTWuA8BetACct/XICC3n7hPDLlRVpwckEyBdyJkXg==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:54:33 GMT
- Content-Length: 174
-
- { "alerts": [
- {
- "text": "cdn was updated.",
- "level": "success"
- }
- ],
- "response": {
- "dnssecEnabled": false,
- "domainName": "test",
- "id": 4,
- "lastUpdated": "2018-11-14 20:54:33+00",
- "name": "quest"
- }}
-
-``DELETE``
-==========
-Allows a user to delete a specific CDN
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+------------------------------------------------------+
- | Name | Description |
- +======+======================================================+
- | ID | The integral, unique identifier of the CDN to delete |
- +------+------------------------------------------------------+
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: Zy4cJN6BEct4ltFLN4e296mM8XnzOs0EQ3/jp4TA3L+g8qtkI0WrL+ThcFq4xbJPU+KHVDSi+b0JBav3xsYPqQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:51:23 GMT
- Content-Length: 58
-
- { "alerts": [
- {
- "text": "cdn was deleted.",
- "level": "success"
- }
- ]}
diff --git a/docs/source/api/v1/cdns_id_queue_update.rst b/docs/source/api/v1/cdns_id_queue_update.rst
deleted file mode 100644
index 9c4e112..0000000
--- a/docs/source/api/v1/cdns_id_queue_update.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-id-queue_update:
-
-****************************
-``cdns/{{ID}}/queue_update``
-****************************
-
-``POST``
-========
-:term:`Queue` or "dequeue" updates for all servers assigned to a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+---------------------------------------------------------------------------+
- | Name | Description |
- +======+===========================================================================+
- | ID | The integral, unique identifier for the CDN on which to (de)queue updates |
- +------+---------------------------------------------------------------------------+
-
-:action: One of "queue" or "dequeue" as appropriate
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/cdns/2/queue_update HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 19
- Content-Type: application/json
-
- {"action": "queue"}
-
-Response Structure
-------------------
-:action: The action processed, either ``"queue"`` or ``"dequeue"``
-:cdnId: The integral, unique identifier for the CDN on which :term:`Queue Updates` was performed or cleared
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: rBpFfrrP+9IFkwsRloEM+v+I8MuBZDXqFu+WUTGtRGypnAn2gHooPoNQRyVvJGjyIQrLXLvqjEtve+lH2Tj4uw==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 21:02:07 GMT
- Content-Length: 41
-
- { "response": {
- "action": "queue",
- "cdnId": 2
- }}
diff --git a/docs/source/api/v1/cdns_id_snapshot.rst b/docs/source/api/v1/cdns_id_snapshot.rst
deleted file mode 100644
index 6e0793b..0000000
--- a/docs/source/api/v1/cdns_id_snapshot.rst
+++ /dev/null
@@ -1,79 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-id-snapshot:
-
-************************
-``cdns/{{ID}}/snapshot``
-************************
-.. deprecated:: ATCv4
- Use the ``PUT`` method of :ref:`to-api-snapshot` with the query parameter ``cdnID`` instead.
-
-``PUT``
-=======
-Performs a CDN :term:`Snapshot`. Effectively, this propagates the new *configuration* of the CDN to its *operating state*, which replaces the output of the :ref:`to-api-v1-cdns-name-snapshot` endpoint with the output of the :ref:`to-api-v1-cdns-name-snapshot-new` endpoint.
-
-.. Note:: Snapshotting the CDN also deletes all HTTPS certificates for every :term:`Delivery Service` which has been deleted since the last CDN :term:`Snapshot`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------------------------------------------------------+
- | Name | Description |
- +======+========================================================================================+
- | ID | The integral, unique identifier of the CDN for which a :term:`Snapshot` shall be taken |
- +------+----------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/cdns/2/snapshot HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: gmaWI0tKgNFPYO0zMrLCGDosBJkPbeIvW4BH9tEh96VjBqyWqzjgPySoMa3ViM1BQXA6VAUOGmc76VyhBsaTzA==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 18 Mar 2020 15:51:48 GMT
- Content-Length: 160
-
- {
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use PUT /snapshots with either the query parameter cdn or cdnID instead",
- "level": "warning"
- }
- ],
- "response": "SUCCESS"
- }
\ No newline at end of file
diff --git a/docs/source/api/v1/cdns_metric_types_metric_start_date_start_end_date_end.rst b/docs/source/api/v1/cdns_metric_types_metric_start_date_start_end_date_end.rst
deleted file mode 100644
index 1ee7f57..0000000
--- a/docs/source/api/v1/cdns_metric_types_metric_start_date_start_end_date_end.rst
+++ /dev/null
@@ -1,95 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-metric_types-metric-start_date-start-end_date-end:
-
-**********************************************************************
-``cdns/metric_types/{{metric}}/start_date/{{start}}/end_date/{{end}}``
-**********************************************************************
-
-.. danger:: This API endpoint *does* **not** *work*. It isn't implemented in Traffic Ops, and is not expected to be added at any point in the near future. See :issue:`2309` for more information.
-
-.. deprecated:: ATCv4
- This endpoint is deprecated, and will not be added in future API versions.
-
-
-``GET``
-=======
-Retrieves :term:`Edge-tier` metrics of one or all :term:`Cache Groups`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-----------------+----------+---------------------------+
- | Name | Required | Description |
- +=================+==========+===========================+
- | ``metric_type`` | yes | ooff, origin_tps |
- +-----------------+----------+---------------------------+
- | ``start`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
- | ``end`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
-
-Response Structure
-------------------
-:stats: object
-
- :count: string
- :98thPercentile: string
- :min: string
- :max: string
- :5thPercentile: string
- :95thPercentile: string
- :mean: string
- :sum: string
-
-:data: array
-
- :time: int
- :value: number
-
-:label: string
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": [ {
- "stats": {
- "count": 1,
- "98thPercentile": 1668.03,
- "min": 1668.03,
- "max": 1668.03,
- "5thPercentile": 1668.03,
- "95thPercentile": 1668.03,
- "mean": 1668.03,
- "sum": 1668.03
- },
- "data": [
- [
- 1425135900000,
- 1668.03
- ],
- [
- 1425136200000,
- null
- ]
- ],
- "label": "Origin TPS"
- }]}
diff --git a/docs/source/api/v1/cdns_name_configs_monitoring.rst b/docs/source/api/v1/cdns_name_configs_monitoring.rst
deleted file mode 100644
index 6368cdd..0000000
--- a/docs/source/api/v1/cdns_name_configs_monitoring.rst
+++ /dev/null
@@ -1,231 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-configs-monitoring:
-
-************************************
-``cdns/{{name}}/configs/monitoring``
-************************************
-
-.. seealso:: :ref:`health-proto`
-
-``GET``
-=======
-Retrieves information concerning the monitoring configuration for a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+------------------------------------------------------------------------+
- | Name | Description |
- +======+========================================================================+
- | name | The name of the CDN for which monitoring configuration will be fetched |
- +------+------------------------------------------------------------------------+
-
-Response Structure
-------------------
-:cacheGroups: An array of objects representing each of the :term:`Cache Groups` being monitored within this CDN
-
- :coordinates: An object representing the geographic location of this :term:`Cache Group`
-
- :latitude: This :ref:`Cache Group's latitude <cache-group-latitude>` as a floating-point number
- :longitude: This :ref:`Cache Group's longitude <cache-group-longitude>` as a floating-point number
-
- :name: A string that is this :ref:`Cache Group's name <cache-group-name>`
-
-:config: A collection of parameters used to configure the monitoring behaviour of Traffic Monitor
-
- :hack.ttl: Unknown
- :health.event-count: The total number of health events to store
- :health.polling.interval: An interval in milliseconds on which to poll for health statistics
- :health.threadPool: The number of threads to be used for health polling
- :health.timepad: A 'padding time' to add to requests to spread them out for Traffic Control systems that use a large number of Traffic Monitors
- :tm.crConfig.polling.url: The URL from which a :term:`Snapshot` can be obtained
- :tm.dataServer.polling.url: The URL from which a list of data servers can be obtained
- :tm.healthParams.polling.url: The URL from which a list of health-polling parameters can be obtained
- :tm.polling.interval: The interval at which to poll for configuration updates
-
-:deliveryServices: An array of objects representing each :term:`Delivery Service` provided by this CDN
-
- :status: The :term:`Delivery Service`'s status
- :totalKbpsThreshold: A threshold rate of data transfer this :term:`Delivery Service` is configured to handle, in Kilobits per second
- :totalTpsThreshold: A threshold amount of transactions per second that this :term:`Delivery Service` is configured to handle
- :xmlId: A string that is the :ref:`Delivery Service's XMLID <ds-xmlid>`
-
-:profiles: An array of the :term:`Profiles` in use by the :term:`cache servers` and :term:`Delivery Services` belonging to this CDN
-
- :name: A string that is the :ref:`Profile's Name <profile-name>`
- :parameters: An array of the :term:`Parameters` in this :term:`Profile` that relate to monitoring configuration. This can be ``null`` if the servers using this :term:`Profile` cannot be monitored (e.g. Traffic Routers)
-
- :health.connection.timeout: A timeout value, in milliseconds, to wait before giving up on a health check request
- :health.polling.url: A URL to request for polling health. Substitutions can be made in a shell-like syntax using the properties of an object from the ``"trafficServers"`` array
- :health.threshold.availableBandwidthInKbps: The total amount of bandwidth that servers using this profile are allowed, in Kilobits per second. This is a string and using comparison operators to specify ranges, e.g. ">10" means "more than 10 kbps"
- :health.threshold.loadavg: The UNIX loadavg at which the server should be marked "unhealthy"
-
- .. seealso:: :manpage:`uptime(1)`
-
- :health.threshold.queryTime: The highest allowed length of time for completing health queries (after connection has been established) in milliseconds
- :history.count: The number of past events to store; once this number is reached, the oldest event will be forgotten before a new one can be added
-
- :type: A string that names the :ref:`Profile's Type <profile-type>`
-
-:trafficMonitors: An array of objects representing each Traffic Monitor that monitors this CDN (this is used by Traffic Monitor's "peer polling" function)
-
- :fqdn: An :abbr:`FQDN (Fully Qualified Domain Name)` that resolves to the IPv4 (and/or IPv6) address of the server running this Traffic Monitor instance
- :hostname: The hostname of the server running this Traffic Monitor instance
- :ip6: The IPv6 address of this Traffic Monitor - when applicable
- :ip: The IPv4 address of this Traffic Monitor
- :port: The port on which this Traffic Monitor listens for incoming connections
- :profile: A string that is the :ref:`profile-name` of the :term:`Profile` assigned to this Traffic Monitor
- :status: The status of the server running this Traffic Monitor instance
-
-:trafficServers: An array of objects that represent the :term:`cache servers` being monitored within this CDN
-
- :cacheGroup: The :term:`Cache Group` to which this :term:`cache server` belongs
- :fqdn: An :abbr:`FQDN (Fully Qualified Domain Name)` that resolves to the :term:`cache server`'s IPv4 (or IPv6) address
- :hashId: The (short) hostname for the :term:`cache server` - named "hashId" for legacy reasons
- :hostName: The (short) hostname of the :term:`cache server`
- :interfacename: The name of the network interface device being used by the :term:`cache server`'s HTTP proxy
- :ip6: The :term:`cache server`'s IPv6 address - when applicable
- :ip: The :term:`cache server`'s IPv4 address
- :port: The port on which the :term:`cache server` listens for incoming connections
- :profile: A string that is the :ref:`profile-name` of the :term:`Profile` assigned to this :term:`cache server`
- :status: The status of the :term:`cache server`
- :type: A string that names the :term:`Type` of the :term:`cache server` - should (ideally) be either ``EDGE`` or ``MID``
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: uLR+tRoqR8SYO38j3DV9wQ+IkJ7Kf+MCoFkcWZtsgbpLJ+0S6f+IiI8laNVeDgrM/P23MAQ6BSepm+EJRl1AXQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 21:09:31 GMT
- Transfer-Encoding: chunked
-
- { "response": {
- "trafficServers": [
- {
- "profile": "ATS_EDGE_TIER_CACHE",
- "status": "REPORTED",
- "ip": "172.16.239.100",
- "ip6": "fc01:9400:1000:8::100",
- "port": 80,
- "cachegroup": "CDN_in_a_Box_Edge",
- "hostname": "edge",
- "fqdn": "edge.infra.ciab.test",
- "interfacename": "eth0",
- "type": "EDGE",
- "hashid": "edge"
- },
- {
- "profile": "ATS_MID_TIER_CACHE",
- "status": "REPORTED",
- "ip": "172.16.239.120",
- "ip6": "fc01:9400:1000:8::120",
- "port": 80,
- "cachegroup": "CDN_in_a_Box_Mid",
- "hostname": "mid",
- "fqdn": "mid.infra.ciab.test",
- "interfacename": "eth0",
- "type": "MID",
- "hashid": "mid"
- }
- ],
- "trafficMonitors": [
- {
- "profile": "RASCAL-Traffic_Monitor",
- "status": "ONLINE",
- "ip": "172.16.239.40",
- "ip6": "fc01:9400:1000:8::40",
- "port": 80,
- "cachegroup": "CDN_in_a_Box_Edge",
- "hostname": "trafficmonitor",
- "fqdn": "trafficmonitor.infra.ciab.test"
- }
- ],
- "cacheGroups": [
- {
- "name": "CDN_in_a_Box_Mid",
- "coordinates": {
- "latitude": 38.897663,
- "longitude": -77.036574
- }
- },
- {
- "name": "CDN_in_a_Box_Edge",
- "coordinates": {
- "latitude": 38.897663,
- "longitude": -77.036574
- }
- }
- ],
- "profiles": [
- {
- "name": "CCR_CIAB",
- "type": "CCR",
- "parameters": null
- },
- {
- "name": "ATS_EDGE_TIER_CACHE",
- "type": "EDGE",
- "parameters": {
- "health.connection.timeout": 2000,
- "health.polling.url": "http://${hostname}/_astats?application=&inf.name=${interface_name}",
- "health.threshold.availableBandwidthInKbps": ">1750000",
- "health.threshold.loadavg": "25.0",
- "health.threshold.queryTime": 1000,
- "history.count": 30
- }
- },
- {
- "name": "ATS_MID_TIER_CACHE",
- "type": "MID",
- "parameters": {
- "health.connection.timeout": 2000,
- "health.polling.url": "http://${hostname}/_astats?application=&inf.name=${interface_name}",
- "health.threshold.availableBandwidthInKbps": ">1750000",
- "health.threshold.loadavg": "25.0",
- "health.threshold.queryTime": 1000,
- "history.count": 30
- }
- }
- ],
- "deliveryServices": [],
- "config": {
- "hack.ttl": 30,
- "health.event-count": 200,
- "health.polling.interval": 6000,
- "health.threadPool": 4,
- "health.timepad": 0,
- "heartbeat.polling.interval": 3000,
- "location": "/opt/traffic_monitor/conf",
- "peers.polling.interval": 3000,
- "tm.crConfig.polling.url": "https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.xml",
- "tm.dataServer.polling.url": "https://${tmHostname}/dataserver/orderby/id",
- "tm.healthParams.polling.url": "https://${tmHostname}/health/${cdnName}",
- "tm.polling.interval": 2000
- }
- }}
diff --git a/docs/source/api/v1/cdns_name_configs_routing.rst b/docs/source/api/v1/cdns_name_configs_routing.rst
deleted file mode 100644
index ad6bc79..0000000
--- a/docs/source/api/v1/cdns_name_configs_routing.rst
+++ /dev/null
@@ -1,309 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-configs-routing:
-
-*********************************
-``cdns/{{name}}/configs/routing``
-*********************************
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cdns-name-snapshot` instead.
-
-``GET``
-=======
-Retrieves CDN routing information.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type:
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +----------+----------+-------------------------------------+
- | Name | Required | Description |
- +==========+==========+=====================================+
- | ``name`` | yes | The name of the CDN to be inspected |
- +----------+----------+-------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.5/cdns/CDN-in-a-Box/configs/routing HTTP/1.1
- User-Agent: curl/7.29.0
- Host: trafficops.infra.ciab.test
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cacheGroups: A collection of objects that represent :term:`Cache Groups`.
-
- :coordinates: An object that represents the geographic location of the :term:`Cache Group`
-
- :latitude: number
- :longitude: number
-
- :name: string
-
-:config: object
-
- :coveragezone.polling.url: string
- :domain_name: string
- :geolocation.polling.interval: integer
- :geolocation.polling.url: string
- :geolocation6.polling.interval: integer
- :geolocation6.polling.url: string
- :tcoveragezone.polling.interval: integer
- :tld.soa.admin: string
- :tld.soa.expire: integer
- :tld.soa.minimum: integer
- :tld.soa.refresh: integer
- :tld.soa.retry: integer
- :tld.ttls.A: integer
- :tld.ttls.AAAA: integer
- :tld.ttls.NS: integer
- :tld.ttls.SOA: integer
-
-:deliveryServices: An array of delivery services.
-
- :coverageZoneOnly: boolean
- :bypassDestination: object
-
- :maxDnsIpsForLocation: integer
- :ttl: integer
- :type: string
-
- :geoEnabled: string
- :matchSets: array
-
- :protocol: string
- :matchList: array
-
- :matchType: string
- :regex: string
-
- :missCoordinates: object
-
- :latitude: number
- :longitude: number
-
- :soa: object
-
- :admin: string
- :expire: integer
- :minimum: integer
- :refresh: integer
- :retry: integer
-
- :ttl: integer
- :ttls: object
-
- :A: integer
- :AAAA: integer
- :NS: integer
- :SOA: integer
-
- :xmlId: string
-
-:stats: object
-
- :cdnName: string
- :date: integer
- :trafficOpsHost: string
- :trafficOpsPath: string
- :trafficOpsUser: string
- :trafficOpsVersion: string
-
-:trafficMonitors: An array of Traffic Monitors
-
- :fqdn: string
- :hostName: string
- :ip6: string
- :ip: string
- :location: string
- :port: integer
- :profile: string
- :status: string
-
-:trafficRouters: object
-
- :apiPort: integer
- :fqdn: string
- :hostName: string
- :ip6: string
- :ip: string
- :location: string
- :port: integer
- :profile: integer
- :status: string
-
-:trafficServers: An array of Traffic Servers.
-
- :cacheGroup: string
- :deliveryServices: array
-
- :xmlId: string
- :remaps: array
- :hostName: string
-
- :fqdn: string
- :hashId: string
- :interfaceName: string
- :ip: string
- :ip6: string
- :port: integer
- :profile: string
- :status: string
- :type: string
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Mon, 27 Jan 2020 19:20:14 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Mon, 27 Jan 2020 23:20:14 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: Dxgtd9e67IRb9HyhPxG94zijfpCB44mdstlf5ZXokCQoAUKbcPaTu2szPMgineWmNvWxAfgrXo0ZVUnCRqxh7A==
- Transfer-Encoding: chunked
-
- {
- "alerts": [
- {
- "level": "warning",
- "text": "This endpoint is deprecated, please use 'GET /cdns/{{name}}/snapshot' instead"
- }
- ],
- "response": {
- "trafficServers": [
- {
- "profile": "ATS_MID_TIER_CACHE",
- "ip": "172.16.239.5",
- "status": "REPORTED",
- "cacheGroup": "CDN_in_a_Box_Mid",
- "ip6": "fc01:9400:1000:8::5",
- "port": 80,
- "deliveryServices": [],
- "hostName": "mid",
- "fqdn": "mid.infra.ciab.test",
- "interfaceName": "eth0",
- "type": "MID",
- "hashId": "mid"
- },
- {
- "profile": "ATS_EDGE_TIER_CACHE",
- "ip": "172.16.239.4",
- "status": "REPORTED",
- "cacheGroup": "CDN_in_a_Box_Edge",
- "ip6": "fc01:9400:1000:8::4",
- "port": 80,
- "deliveryServices": [],
- "hostName": "edge",
- "fqdn": "edge.infra.ciab.test",
- "interfaceName": "eth0",
- "type": "EDGE",
- "hashId": "edge"
- }
- ],
- "stats": {
- "trafficOpsPath": "/api/1.5/cdns/CDN-in-a-Box/configs/routing",
- "cdnName": "CDN-in-a-Box",
- "trafficOpsVersion": "4.0.0-10449.03d91ae3.el7",
- "trafficOpsUser": "admin",
- "date": 1580152814,
- "trafficOpsHost": "trafficops.infra.ciab.test"
- },
- "cacheGroups": [
- {
- "coordinates": {
- "longitude": -77.036574,
- "latitude": 38.897663
- },
- "name": "CDN_in_a_Box_Edge"
- },
- {
- "coordinates": {
- "longitude": -77.036574,
- "latitude": 38.897663
- },
- "name": "CDN_in_a_Box_Mid"
- }
- ],
- "config": {
- "tld.soa.admin": "twelve_monkeys",
- "dnssec.dynamic.response.expiration": "300s",
- "api.cache-control.max-age": 10,
- "neustar.polling.url": "https://trafficops.infra.ciab.test:443/neustar.tar.gz",
- "zonemanager.threadpool.scale": "0.50",
- "coveragezone.polling.interval": 3600000,
- "federationmapping.polling.interval": 60000,
- "steeringmapping.polling.interval": 60000,
- "tld.ttls.DNSKEY": 30,
- "geolocation.polling.interval": 86400000,
- "tld.soa.expire": 604800,
- "federationmapping.polling.url": "https://${toHostname}/api/1.5/federations/all",
- "coveragezone.polling.url": "https://trafficops.infra.ciab.test:443/coverage-zone.json",
- "tld.soa.minimum": 30,
- "geolocation.polling.url": "https://trafficops.infra.ciab.test:443/GeoLite2-City.mmdb.gz",
- "keystore.maintenance.interval": 300,
- "zonemanager.cache.maintenance.interval": 300,
- "domain_name": "mycdn.ciab.test",
- "tld.ttls.AAAA": 3600,
- "tld.soa.refresh": 28800,
- "consistent.dns.routing": "true",
- "tld.ttls.SOA": 86400,
- "neustar.polling.interval": 86400000,
- "tld.ttls.NS": 3600,
- "tld.ttls.DS": 30,
- "certificates.polling.interval": 300000,
- "tld.ttls.A": 3600,
- "tld.soa.retry": 7200
- },
- "trafficMonitors": [
- {
- "profile": "RASCAL-Traffic_Monitor",
- "location": "CDN_in_a_Box_Edge",
- "ip": "172.16.239.11",
- "status": "ONLINE",
- "ip6": "fc01:9400:1000:8::b",
- "port": 80,
- "hostName": "trafficmonitor",
- "fqdn": "trafficmonitor.infra.ciab.test"
- }
- ],
- "trafficRouters": [
- {
- "profile": "CCR_CIAB",
- "location": "CDN_in_a_Box_Edge",
- "ip": "172.16.239.12",
- "status": "ONLINE",
- "secureApiPort": 3333,
- "ip6": "fc01:9400:1000:8::c",
- "port": 80,
- "hostName": "trafficrouter",
- "fqdn": "trafficrouter.infra.ciab.test",
- "apiPort": 3333
- }
- ]
- }
- }
diff --git a/docs/source/api/v1/cdns_name_dnsseckeys_ksk_generate.rst b/docs/source/api/v1/cdns_name_dnsseckeys_ksk_generate.rst
deleted file mode 100644
index ff1f8b2..0000000
--- a/docs/source/api/v1/cdns_name_dnsseckeys_ksk_generate.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-dnsseckeys-ksk-generate:
-
-*****************************************
-``cdns/{{name}}/dnsseckeys/ksk/generate``
-*****************************************
-
-.. versionadded:: 1.4
-
-``POST``
-========
-Generates a new :abbr:`KSK (Key-Signing Key)` for a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object (string)
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------+-----------------------------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+===================================================================================+
- | name | yes | The name of the CDN for which the :abbr:`KSK (Key-Signing Key)` will be generated |
- +------+----------+-----------------------------------------------------------------------------------+
-
-:expirationDays: The integral number of days until the newly generated :abbr:`KSK (Key-Signing Key)` expires
-:effectiveDate: An optional string containing the date and time at which the newly generated :abbr:`KSK (Key-Signing Key)` becomes effective, in :RFC:`3339` format. Defaults to the current time if not specified
-
-Response Structure
-------------------
-.. code-block:: json
- :caption: Response Example
-
- { "response": "Successfully generated ksk dnssec keys for my-cdn-name" }
diff --git a/docs/source/api/v1/cdns_name_federations.rst b/docs/source/api/v1/cdns_name_federations.rst
deleted file mode 100644
index 8f6f372..0000000
--- a/docs/source/api/v1/cdns_name_federations.rst
+++ /dev/null
@@ -1,195 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-federations:
-
-*****************************
-``cdns/{{name}}/federations``
-*****************************
-
-``GET``
-=======
-Retrieves a list of federations in use by a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +===========+===============================================================================================================+
- | name | The name of the CDN for which federations will be listed |
- +-----------+---------------------------------------------------------------------------------------------------------------+
-
-.. table:: Request Query Parameters
-
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +===========+===============================================================================================================+
- | id | Return only the federation that has this id |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | orderby | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | array |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | limit | Choose the maximum number of results to return |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | offset | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | page | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | defined to make use of ``page``. |
- +-----------+---------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cdns/CDN-in-a-Box/federations HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.62.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cname: The Canonical Name (CNAME) used by the federation
-:deliveryService: An object with keys that provide identifying information for the :term:`Delivery Service` using this federation
-
- :id: The integral, unique identifier for the :term:`Delivery Service`
- :xmlId: The :term:`Delivery Service`'s uniquely identifying 'xml_id'
-
-:description: An optionally-present field containing a description of the field
-
- .. note:: This key will only be present if the description was provided when the federation was created. Refer to the ``POST`` method of this endpoint to see how federations can be created.
-
-:lastUpdated: The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
-:ttl: Time to Live (TTL) for the ``cname``, in hours
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- access-control-allow-credentials: true
- access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- access-control-allow-methods: POST,GET,OPTIONS,PUT,DELETE
- access-control-allow-origin: *
- content-type: application/json
- set-cookie: mojolicious=...; Path=/; HttpOnly
- whole-content-sha512: SJA7G+7G5KcOfCtnE3Dq5DCobWtGRUKSppiDkfLZoG5+paq4E1aZGqUb6vGVsd+TpPg75MLlhyqfdfCHnhLX/g==
- x-server-name: traffic_ops_golang/
- content-length: 170
- date: Wed, 05 Dec 2018 00:35:40 GMT
-
- { "response": [
- {
- "id": 1,
- "cname": "test.quest.",
- "ttl": 48,
- "description": "A test federation",
- "lastUpdated": "2018-12-05 00:05:16+00",
- "deliveryService": {
- "id": 1,
- "xmlId": "demo1"
- }
- }
- ]}
-
-``POST``
-========
-Creates a new federation.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------------------------------+
- | Name | Description |
- +======+================================================================+
- | name | The name of the CDN for which a new federation will be created |
- +------+----------------------------------------------------------------+
-
-:cname: The Canonical Name (CNAME) used by the federation
-
- .. note:: The CNAME must end with a "``.``"
-
-:description: An optional description of the federation
-:ttl: Time to Live (TTL) for the name record used for ``cname``
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/cdns/CDN-in-a-Box/federations HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.62.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 72
- Content-Type: application/json
-
- {
- "cname": "test.quest.",
- "ttl": 48,
- "description": "A test federation"
- }
-
-
-Response Structure
-------------------
-:cname: The Canonical Name (CNAME) used by the federation
-:description: An optionally-present field containing a description of the field
-
- .. note:: This key will only be present if the description was provided when the federation was created
-
-:lastUpdated: The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
-:ttl: Time to Live (TTL) for the ``cname``, in hours
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- access-control-allow-credentials: true
- access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- access-control-allow-methods: POST,GET,OPTIONS,PUT,DELETE
- access-control-allow-origin: *
- content-type: application/json
- set-cookie: mojolicious=...; Path=/; HttpOnly
- whole-content-sha512: rRsWAIhXzVlj8Hy+8aFjp4Jo1QGTK49m0N1AP5QDyyAZ1TfNIdgtcgiuehu7FiN1IPWRFiv6D9CygFYKGcVDOw==
- x-server-name: traffic_ops_golang/
- content-length: 192
- date: Wed, 05 Dec 2018 00:05:16 GMT
-
- { "alerts": [
- {
- "text": "cdnfederation was created.",
- "level": "success"
- }
- ],
- "response": {
- "id": 1,
- "cname": "test.quest.",
- "ttl": 48,
- "description": "A test federation",
- "lastUpdated": "2018-12-05 00:05:16+00"
- }}
diff --git a/docs/source/api/v1/cdns_name_federations_id.rst b/docs/source/api/v1/cdns_name_federations_id.rst
deleted file mode 100644
index f82fad9..0000000
--- a/docs/source/api/v1/cdns_name_federations_id.rst
+++ /dev/null
@@ -1,260 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-federations-id:
-
-************************************
-``cdns/{{name}}/federations/{{ID}}``
-************************************
-
-``GET``
-=======
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cdns-name-federations` with the query parameter ``id`` instead.
-
-Retrieves a specific federation used within a specific CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +-----------+-------------------------------------------------------------------------------------+
- | Name | Description |
- +===========+=====================================================================================+
- | name | The name of the CDN for which the federation identified by ``ID`` will be inspected |
- +-----------+-------------------------------------------------------------------------------------+
- | ID | An integral, unique identifier for the federation to be inspected |
- +-----------+-------------------------------------------------------------------------------------+
-
-.. table:: Request Query Parameters
-
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +===========+===============================================================================================================+
- | orderby | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | array |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | limit | Choose the maximum number of results to return |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | offset | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-----------+---------------------------------------------------------------------------------------------------------------+
- | page | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | defined to make use of ``page``. |
- +-----------+---------------------------------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cdns/CDN-in-a-Box/federations/1 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.62.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cname: The Canonical Name (CNAME) used by the federation
-:deliveryService: An object with keys that provide identifying information for the :term:`Delivery Service` using this federation
-
- :id: The integral, unique identifer for the :term:`Delivery Service`
- :xmlId: The :term:`Delivery Service`'s uniquely identifying 'xml_id'
-
-:description: An optionally-present field containing a description of the field
-
- .. note:: This key will only be present if the description was provided when the federation was created. Refer to the ``POST`` method of the :ref:`to-api-v1-cdns-name-federations` endpoint to see how federations can be created.
-
-:lastUpdated: The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
-:ttl: Time to Live (TTL) for the ``cname``, in hours
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- access-control-allow-credentials: true
- access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- access-control-allow-methods: POST,GET,OPTIONS,PUT,DELETE
- access-control-allow-origin: *
- content-type: application/json
- set-cookie: mojolicious=...; Path=/; HttpOnly
- whole-content-sha512: SJA7G+7G5KcOfCtnE3Dq5DCobWtGRUKSppiDkfLZoG5+paq4E1aZGqUb6vGVsd+TpPg75MLlhyqfdfCHnhLX/g==
- x-server-name: traffic_ops_golang/
- content-length: 170
- date: Wed, 05 Dec 2018 00:36:57 GMT
-
- { "response": [
- {
- "id": 1,
- "cname": "test.quest.",
- "ttl": 48,
- "description": "A test federation",
- "lastUpdated": "2018-12-05 00:05:16+00",
- "deliveryService": {
- "id": 1,
- "xmlId": "demo1"
- }
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cdns/{name}/federations with query parameter id instead",
- "level": "warning"
- }
- ]}
-
-
-``PUT``
-=======
-Updates a federation.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+-------------------------------------------------------------------------------------+
- | Name | Description |
- +======+=====================================================================================+
- | name | The name of the CDN for which the federation identified by ``ID`` will be inspected |
- +------+-------------------------------------------------------------------------------------+
- | ID | An integral, unique identifier for the federation to be inspected |
- +------+-------------------------------------------------------------------------------------+
-
-:cname: The Canonical Name (CNAME) used by the federation
-
- .. note:: The CNAME must end with a "``.``"
-
-:description: An optional description of the federation
-:ttl: Time to Live (TTL) for the name record used for ``cname``
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/cdns/CDN-in-a-Box/federations/1 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.62.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 33
- Content-Type: application/json
-
- {
- "cname": "foo.bar.",
- "ttl": 48
- }
-
-
-Response Structure
-------------------
-:cname: The Canonical Name (CNAME) used by the federation
-:description: An optionally-present field containing a description of the field
-
- .. note:: This key will only be present if the description was provided when the federation was created
-
-:lastUpdated: The date and time at which this federation was last modified, in :ref:`non-rfc-datetime`
-:ttl: Time to Live (TTL) for the ``cname``, in hours
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- access-control-allow-credentials: true
- access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- access-control-allow-methods: POST,GET,OPTIONS,PUT,DELETE
- access-control-allow-origin: *
- content-type: application/json
- set-cookie: mojolicious=...; Path=/; HttpOnly
- whole-content-sha512: qcjfQ+gDjNxYQ1aq+dlddgrkFWnkFYxsFF+SHDqqH0uVHBVksmU0aTFgltozek/u6wbrGoR1LFf9Fr1C1SbigA==
- x-server-name: traffic_ops_golang/
- content-length: 174
- date: Wed, 05 Dec 2018 01:03:40 GMT
-
- { "alerts": [
- {
- "text": "cdnfederation was updated.",
- "level": "success"
- }
- ],
- "response": {
- "id": 1,
- "cname": "foo.bar.",
- "ttl": 48,
- "description": null,
- "lastUpdated": "2018-12-05 01:03:40+00"
- }}
-
-
-``DELETE``
-==========
-Deletes a specific federation.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+-------------------------------------------------------------------------------------+
- | Name | Description |
- +======+=====================================================================================+
- | name | The name of the CDN for which the federation identified by ``ID`` will be inspected |
- +------+-------------------------------------------------------------------------------------+
- | ID | An integral, unique identifier for the federation to be inspected |
- +------+-------------------------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/1.4/cdns/CDN-in-a-Box/federations/1 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.62.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- access-control-allow-credentials: true
- access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- access-control-allow-methods: POST,GET,OPTIONS,PUT,DELETE
- access-control-allow-origin: *
- content-type: application/json
- set-cookie: mojolicious=...; Path=/; HttpOnly
- whole-content-sha512: Cnkfj6dmzTD3if9oiDq33tqf7CnAflKK/SPgqJyfu6HUfOjLJOgKIZvkcs2wWY6EjLVdw5qsatsd4FPoCyjvcw==
- x-server-name: traffic_ops_golang/
- content-length: 68
- date: Wed, 05 Dec 2018 01:17:24 GMT
-
- { "alerts": [
- {
- "text": "cdnfederation was deleted.",
- "level": "success"
- }
- ]}
diff --git a/docs/source/api/v1/cdns_name_health.rst b/docs/source/api/v1/cdns_name_health.rst
deleted file mode 100644
index 626aabb..0000000
--- a/docs/source/api/v1/cdns_name_health.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-health:
-
-************************
-``cdns/{{name}}/health``
-************************
-
-``GET``
-=======
-Retrieves the health of all :term:`Cache Groups` for a given CDN.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+-------------------------------------------------------+
- | Name | Description |
- +======+=======================================================+
- | name | The name of the CDN for which health will be reported |
- +------+-------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cdns/CDN-in-a-Box/health HTTP/1.1
- User-Agent: python-requests/2.22.0
- Accept-Encoding: gzip, deflate
- Accept: */*
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cachegroups: An array of objects describing the health of each :term:`Cache Group`
-
- :name: A string that is the :ref:`Cache Group's Name <cache-group-name>`
- :offline: The number of OFFLINE :term:`cache servers` in the :term:`Cache Group`
- :online: The number of ONLINE :term:`cache servers` in the :term:`Cache Group`
-
-:totalOffline: Total number of OFFLINE :term:`cache servers` across all :term:`Cache Groups` which are assigned to the CDN defined by the ``name`` request path parameter
-:totalOnline: Total number of ONLINE :term:`cache servers` across all :term:`Cache Groups` which are assigned to the CDN defined by the ``name`` request path parameter
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Encoding: gzip
- Content-Length: 108
- Content-Type: application/json
- Date: Tue, 03 Dec 2019 21:33:59 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; expires=Wed, 04 Dec 2019 01:33:59 GMT; path=/; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: KpXViXeAgch58ueQqdyU8NuINBw1EUedE6Rv2ewcLUajJp6kowdbVynpwW7XiSvAyHdtClIOuT3OkhIimghzSA==
-
- { "response": {
- "totalOffline": 0,
- "totalOnline": 1,
- "cachegroups": [
- {
- "offline": 0,
- "name": "CDN_in_a_Box_Edge",
- "online": 1
- }
- ]
- }}
diff --git a/docs/source/api/v1/cdns_name_name.rst b/docs/source/api/v1/cdns_name_name.rst
deleted file mode 100644
index 4fbfe60..0000000
--- a/docs/source/api/v1/cdns_name_name.rst
+++ /dev/null
@@ -1,122 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-name:
-
-**********************
-``cdns/name/{{name}}``
-**********************
-
-``GET``
-=======
-.. deprecated:: ATCv4
- Use the ``GET`` method of :ref:`to-api-v1-cdns` with the query parameter ``name`` instead.
-
-Extract information about a CDN, identified by name.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+---------------------------------------------+
- | Name | Description |
- +======+=============================================+
- | name | The name of the CDN to be inspected |
- +------+---------------------------------------------+
-
-Response Structure
-------------------
-:dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
-:domainName: Top Level Domain name within which this CDN operates
-:id: The integral, unique identifier for the CDN
-:lastUpdated: Date and time when the CDN was last modified in :ref:`non-rfc-datetime`
-:name: The name of the CDN
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: bTz86xdnGfbKhxnneb4geXohaw3lhG+h5wc21/ncHFATwp1h80h+txxySCIVfa0hgBrJHEdpGZQsH5w5IknsrQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 21:22:16 GMT
- Content-Length: 137
-
- { "response": [
- {
- "dnssecEnabled": false,
- "domainName": "mycdn.ciab.test",
- "id": 2,
- "lastUpdated": "2018-11-14 18:21:14+00",
- "name": "CDN-in-a-Box"
- }
- ],
- "alerts": [
- {
- "text": "This endpoint is deprecated, please use GET /cdns with query parameter name instead",
- "level": "warning"
- }
- ]}
-
-``DELETE``
-==========
-Allows a user to delete a CDN by name
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+---------------------------------------------+
- | Name | Description |
- +======+=============================================+
- | name | The name of the CDN to be deleted |
- +------+---------------------------------------------+
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: Zy4cJN6BEct4ltFLN4e296mM8XnzOs0EQ3/jp4TA3L+g8qtkI0WrL+ThcFq4xbJPU+KHVDSi+b0JBav3xsYPqQ==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 20:59:22 GMT
- Content-Length: 58
-
- { "alerts": [
- {
- "text": "cdn was deleted.",
- "level": "success"
- }
- ]}
diff --git a/docs/source/api/v1/cdns_name_name_dnsseckeys.rst b/docs/source/api/v1/cdns_name_name_dnsseckeys.rst
deleted file mode 100644
index 35fd910..0000000
--- a/docs/source/api/v1/cdns_name_name_dnsseckeys.rst
+++ /dev/null
@@ -1,115 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-name-dnsseckeys:
-
-*********************************
-``cdns/name/{{name}}/dnsseckeys``
-*********************************
-
-``GET``
-=======
-Gets a list of DNSSEC keys for CDN and all associated :term:`Delivery Services`. Before returning response to user, this will make sure DNSSEC keys for all :term:`Delivery Services` exist and are not expired. If they don't exist or are expired, they will be (re-)generated.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------------------+
- | Name | Description |
- +======+====================================================+
- | name | The name of the CDN for which keys will be fetched |
- +------+----------------------------------------------------+
-
-Response Structure
-------------------
-:name: The name of the CDN or :term:`Delivery Service` to which the enclosed keys belong
-
- :zsk: The short-term :abbr:`ZSK (Zone-Signing Key)`
-
- :expirationDate: A Unix epoch timestamp (in seconds) representing the date and time whereupon the key will expire
- :inceptionDate: A Unix epoch timestamp (in seconds) representing the date and time when the key was created
- :name: The name of the domain for which this key will be used
- :private: Encoded private key
- :public: Encoded public key
- :ttl: The time for which the key should be trusted by the client
-
- :ksk: The long-term :abbr:`KSK (Key-Signing Key)`
-
- :dsRecord: An optionally present object containing information about the algorithm used to generate the key
-
- .. versionadded:: 1.2
-
- :algorithm: The name of the algorithm used to generate the key
- :digest: A hash of the DNSKEY record
- :digestType: The type of hash algorithm used to create the value of ``digest``
-
- :expirationDate: A Unix epoch timestamp (in seconds) representing the date and time whereupon the key will expire
- :inceptionDate: A Unix epoch timestamp (in seconds) representing the date and time when the key was created
- :name: The name of the domain for which this key will be used
- :private: Encoded private key
- :public: Encoded public key
- :ttl: The time for which the key should be trusted by the client
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60",
- "dsRecord": {
- "algorithm": "5",
- "digestType": "2",
- "digest": "abc123def456"
- }
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- }
- }}
-
diff --git a/docs/source/api/v1/cdns_name_name_dnsseckeys_delete.rst b/docs/source/api/v1/cdns_name_name_dnsseckeys_delete.rst
deleted file mode 100644
index 87606f5..0000000
--- a/docs/source/api/v1/cdns_name_name_dnsseckeys_delete.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-name-dnsseckeys-delete:
-
-****************************************
-``cdns/name/{{name}}/dnsseckeys/delete``
-****************************************
-
-``GET``
-=======
-Delete DNSSEC keys for a CDN and all associated :term:`Delivery Services`.
-
-.. deprecated:: ATCv4
- Use the ``DELETE`` method of :ref:`to-api-cdns-name-name-dnsseckeys` instead.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Object (string)
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+-----------------------------------------------------------+
- | Name | Description |
- +======+===========================================================+
- | name | The name of the CDN for which DNSSEC keys will be deleted |
- +------+-----------------------------------------------------------+
-
-Response Structure
-------------------
-.. code-block:: json
- :caption: Response Example
-
- {
- "alerts": [{
- "level": "warning",
- "text": "This endpoint is deprected, please use DELETE /cdns/name/{name}/dnsseckeys instead"
- }],
- "response": "Successfully deleted dnssec keys for test"
- }
-
diff --git a/docs/source/api/v1/cdns_name_name_sslkeys.rst b/docs/source/api/v1/cdns_name_name_sslkeys.rst
deleted file mode 100644
index 11e109c..0000000
--- a/docs/source/api/v1/cdns_name_name_sslkeys.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-name-sslkeys:
-
-******************************
-``cdns/name/{{name}}/sslkeys``
-******************************
-
-``GET``
-=======
-Returns SSL certificates for all :term:`Delivery Services` that are a part of the CDN.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+----------------------------------------------------+
- | Name | Description |
- +======+====================================================+
- | name | The name of the CDN for which keys will be fetched |
- +------+----------------------------------------------------+
-
-Response Structure
-------------------
-:certificate: An object representing The SSL keys used for the :term:`Delivery Service` identified by ``deliveryservice``
-
- :key: Base 64-encoded private key for SSL certificate
- :crt: Base 64-encoded SSL certificate
-
-:deliveryservice: A string that is the :ref:`ds-xmlid` of the :term:`Delivery Service` using the SSL key within ``certificate``
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": [
- {
- "deliveryservice": "ds1",
- "certificate": {
- "crt": "base64encodedcrt1",
- "key": "base64encodedkey1"
- }
- },
- {
- "deliveryservice": "ds2",
- "certificate": {
- "crt": "base64encodedcrt2",
- "key": "base64encodedkey2"
- }
- }
- ]}
diff --git a/docs/source/api/v1/cdns_name_snapshot.rst b/docs/source/api/v1/cdns_name_snapshot.rst
deleted file mode 100644
index 0878e6f..0000000
--- a/docs/source/api/v1/cdns_name_snapshot.rst
+++ /dev/null
@@ -1,553 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-snapshot:
-
-**************************
-``cdns/{{name}}/snapshot``
-**************************
-.. caution:: This page is a stub! Much of it may be missing or just downright wrong - it needs a lot of love from people with the domain knowledge required to update it.
-
-``GET``
-=======
-Retrieves the *current* :term:`Snapshot` for a CDN, which represents the current *operating state* of the CDN, **not** the current *configuration* of the CDN. The contents of this :term:`Snapshot` are currently used by Traffic Monitor and Traffic Router.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+--------------------------------------------------------------------+
- | Name | Description |
- +======+====================================================================+
- | name | The name of the CDN for which a :term:`Snapshot` shall be returned |
- +------+--------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cdns/CDN-in-a-Box/snapshot HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:config: An object containing basic configurations on the actual CDN object
-
- :api.cache-control.max-age: A string containing an integer which specifies the value of ``max-age`` in the :mailheader:`Cache-Control` header of some HTTP responses, likely the :ref:`tr-api` responses
- :certificates.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for updated SSL certificates
- :consistent.dns.routing: A string containing a boolean which indicates whether DNS routing will use a consistent hashing method or "round-robin"
-
- "false"
- The "round-robin" method will be used to define DNS routing
- "true"
- A consistent hashing method will be used to define DNS routing
-
- :coveragezone.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should check for a new Coverage Zone file
- :coveragezone.polling.url: The URL where a :term:`Coverage Zone File` may be requested by Traffic Routers
- :dnssec.dynamic.response.expiration: A string containing a number and unit suffix that specifies the length of time for which dynamic responses to DNSSEC lookup queries should remain valid
- :dnssec.dynamic.concurrencylevel: An integer that defines the size of the concurrency level (threads) of the Guava cache used by ZoneManager to store zone material
- :dnssec.dynamic.initialcapacity: An integer that defines the initial size of the Guava cache, default is 10000. Too low of a value can lead to expensive resizing
- :dnssec.init.timeout: An integer that defines the number of minutes to allow for zone generation, this bounds the zone priming activity
- :dnssec.enabled: A string that tells whether or not the CDN uses DNSSEC; one of:
-
- "false"
- DNSSEC is not used within this CDN
- "true"
- DNSSEC is used within this CDN
-
- :domain_name: A string that is the :abbr:`TLD (Top-Level Domain)` served by the CDN
- :federationmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new federation mappings
- :federationmapping.polling.url: The URL where Traffic Control components can request federation mappings
- :geolocation.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
- :geolocation.polling.url: The URL where Traffic Control components can request IP-to-geographic-location mapping database files
- :keystore.maintenance.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should refresh their zone caches
- :neustar.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new "Neustar" databases
- :neustar.polling.url: The URL where Traffic Control components can request "Neustar" databases
- :soa: An object defining the :abbr:`SOA (Start of Authority)` for the CDN's :abbr:`TLD (Top-Level Domain)` (defined in ``domain_name``)
-
- :admin: The name of the administrator for this zone - i.e. the RNAME
-
- .. note:: This rarely represents a proper email address, unfortunately.
-
- :expire: A string containing an integer that sets the number of seconds after which secondary name servers should stop answering requests for this zone if the master does not respond
- :minimum: A string containing an integer that sets the :abbr:`TTL (Time To Live)` - in seconds - of the record for the purpose of negative caching
- :refresh: A string containing an integer that sets the number of seconds after which secondary name servers should query the master for the :abbr:`SOA (Start of Authority)` record, to detect zone changes
- :retry: A string containing an integer that sets the number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond
-
- .. note:: :rfc:`1035` dictates that this should always be less than ``refresh``.
-
- .. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.
-
- :steeringmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Control components should check for new steering mappings
- :ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
- :zonemanager.cache.maintenance.interval: A configuration option for the ZoneManager Java class of Traffic Router
- :zonemanager.threadpool.scale: A configuration option for the ZoneManager Java class of Traffic Router
-
-:contentRouters: An object containing keys which are the (short) hostnames of the Traffic Routers that serve requests for :term:`Delivery Services` in this CDN
-
- :api.port: A string containing the port number on which the :ref:`tr-api` is served by this Traffic Router via HTTP
- :secure.api.port: An optionally present string containing the port number on which the :ref:`tr-api` is served by this Traffic Router via HTTPS
- :fqdn: This Traffic Router's :abbr:`FQDN (Fully Qualified Domain Name)`
- :httpsPort: The port number on which this Traffic Router listens for incoming HTTPS requests
- :ip: This Traffic Router's IPv4 address
- :ip6: This Traffic Router's IPv6 address
- :location: A string which is the :ref:`cache-group-name` of the :term:`Cache Group` to which this Traffic Router belongs
- :port: The port number on which this Traffic Router listens for incoming HTTP requests
- :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Router
- :status: The health status of this Traffic Router
-
- .. seealso:: :ref:`health-proto`
-
-:contentServers: An object containing keys which are the (short) hostnames of the :term:`Edge-tier cache servers` in the CDN; the values corresponding to those keys are routing information for said servers
-
- :cacheGroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` to which the server belongs
- :deliveryServices: An object containing keys which are the names of :term:`Delivery Services` to which this :term:`cache server` is assigned; the values corresponding to those keys are arrays of :abbr:`FQDNs (Fully Qualified Domain Names)` that resolve to this :term:`cache server`
-
- .. note:: Only :term:`Edge-tier cache servers` can be assigned to a :term:`Delivery Service`, and therefore this field will only be present when ``type`` is ``"EDGE"``.
-
- :fqdn: The server's :abbr:`FQDN (Fully Qualified Domain Name)`
- :hashCount: The number of servers to be placed into a single "hash ring" in Traffic Router
- :hashId: A unique string to be used as the key for hashing servers - as of version 3.0.0 of Traffic Control, this is always the same as the server's (short) hostname and only still exists for legacy compatibility reasons
- :httpsPort: The port on which the :term:`cache server` listens for incoming HTTPS requests
- :interfaceName: The name of the main network interface device used by this :term:`cache server`
- :ip6: The server's IPv6 address
- :ip: The server's IPv4 address
- :locationId: This field is exactly the same as ``cacheGroup`` and only exists for legacy compatibility reasons
- :port: The port on which this :term:`cache server` listens for incoming HTTP requests
- :profile: The :ref:`profile-name` of the :term:`Profile` used by the :term:`cache server`
- :routingDisabled: An integer representing the boolean concept of whether or not Traffic Routers should route client traffic to this :term:`cache server`; one of:
-
- 0
- Do not route traffic to this server
- 1
- Route traffic to this server normally
-
- :status: This :term:`cache server`'s status
-
- .. seealso:: :ref:`health-proto`
-
- :type: The :term:`Type` of this :term:`cache server`; which ought to be one of (but in practice need not be in certain special circumstances):
-
- EDGE
- This is an :term:`Edge-tier cache server`
- MID
- This is a :term:`Mid-tier cache server`
-
-:deliveryServices: An object containing keys which are the :ref:`xml_ids <ds-xmlid>` of all of the :term:`Delivery Services` within the CDN
-
- :anonymousBlockingEnabled: A string containing a boolean that tells whether or not :ref:`ds-anonymous-blocking` is set on this :term:`Delivery Service`; one of:
-
- "true"
- Anonymized IP addresses are blocked by this :term:`Delivery Service`
- "false"
- Anonymized IP addresses are not blocked by this :term:`Delivery Service`
-
- .. seealso:: :ref:`anonymous_blocking-qht`
-
- :consistentHashQueryParameters: A set of query parameters that Traffic Router should consider when determining a consistent hash for a given client request.
-
- .. versionadded:: ATCv4
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- :consistentHashRegex: An optional regular expression that will ensure clients are consistently routed to a :term:`cache server` based on matches to it.
-
- .. versionadded:: ATCv4
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- :coverageZoneOnly: A string containing a boolean that tells whether or not this :term:`Delivery Service` routes traffic based only on its :term:`Coverage Zone File`
-
- .. seealso:: :ref:`ds-geo-limit`
-
- :deepCachingType: A string that defines the :ref:`ds-deep-caching` setting of this :term:`Delivery Service`
- :dispersion: An object describing the "dispersion" - or number of :term:`cache servers` within a single :term:`Cache Group` across which the same content is spread - within the :term:`Delivery Service`
-
- :limit: The maximum number of :term:`cache servers` in which the response to a single request URL will be stored
-
- .. note:: If this is greater than the number of :term:`cache servers` in the :term:`Cache Group` chosen to service the request, then content will be spread across all of them. That is, it causes no problems.
-
- :shuffled: A string containing a boolean that tells whether the :term:`cache servers` chosen for content dispersion are chosen randomly or based on a consistent hash of the request URL; one of:
-
- "false"
- :term:`cache servers` will be chosen consistently
- "true"
- :term:`cache servers` will be chosen at random
-
- :domains: An array of domains served by this :term:`Delivery Service`
- :ecsEnabled: A string containing a boolean from :ref:`ds-ecs` that tells whether EDNS0 client subnet is enabled on this :term:`Delivery Service`; one of:
-
- "false"
- EDNS0 client subnet is not enabled on this :term:`Delivery Service`
- "true"
- EDNS0 client subnet is enabled on this :term:`Delivery Service`
-
- :geolocationProvider: The name of a provider for IP-to-geographic-location mapping services - currently the only valid value is ``"maxmindGeolocationService"``
- :ip6RoutingEnabled: A string containing a boolean that defines the :ref:`ds-ipv6-routing` setting for this :term:`Delivery Service`; one of:
-
- "false"
- IPv6 traffic will not be routed by this :term:`Delivery Service`
- "true"
- IPv6 traffic will be routed by this :term:`Delivery Service`
-
- :matchList: An array of methods used by Traffic Router to determine whether or not a request can be serviced by this :term:`Delivery Service`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integral, unique identifier for the set of types to which the ``type`` field belongs
- :type: The name of the :term:`Type` of match performed using ``pattern`` to determine whether or not to use this :term:`Delivery Service`
-
- HOST_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the :mailheader:`Host` HTTP header of an HTTP request, or the name requested for resolution in a DNS request
- HEADER_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches an HTTP header (both the name and value) in an HTTP request\ [#httpOnly]_
- PATH_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the request path of this :term:`Delivery Service`'s URL\ [#httpOnly]_
- STEERING_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the :ref:`ds-xmlid` of one of this :term:`Delivery Service`'s "Steering" target :term:`Delivery Services`
-
- :missLocation: An object representing the default geographic coordinates to use for a client when lookup of their IP has failed in both the :term:`Coverage Zone File` (and/or possibly the :term:`Deep Coverage Zone File`) and the IP-to-geographic-location database
-
- :lat: Geographic latitude as a floating point number
- :long: Geographic longitude as a floating point number
-
- :protocol: An object that describes how the :term:`Delivery Service` ought to handle HTTP requests both with and without TLS encryption
-
- :acceptHttps: A string containing a boolean that tells whether HTTPS requests should be normally serviced by this :term:`Delivery Service`; one of:
-
- "false"
- Refuse to service HTTPS requests
- "true"
- Service HTTPS requests normally
-
- :redirectToHttps: A string containing a boolean that tells whether HTTP requests ought to be re-directed to use HTTPS; one of:
-
- "false"
- Do not redirect unencrypted traffic; service it normally
- "true"
- Respond to HTTP requests with instructions to use HTTPS instead
-
- .. seealso:: :ref:`ds-protocol`
-
- :regionalGeoBlocking: A string containing a boolean that defines the :ref:`ds-regionalgeo` setting of this :term:`Delivery Service`; one of:
-
- "false"
- Regional Geographic Blocking is not used by this :term:`Delivery Service`
- "true"
- Regional Geographic Blocking is used by this :term:`Delivery Service`
-
- .. seealso:: :ref:`regionalgeo-qht`
-
- :routingName: A string that is this :ref:`Delivery Service's Routing Name <ds-routing-name>`
- :soa: An object defining the :abbr:`SOA (Start of Authority)` record for the :term:`Delivery Service`'s :abbr:`TLDs (Top-Level Domains)` (defined in ``domains``)
-
- :admin: The name of the administrator for this zone - i.e. the RNAME
-
- .. note:: This rarely represents a proper email address, unfortunately.
-
- :expire: A string containing an integer that sets the number of seconds after which secondary name servers should stop answering requests for this zone if the master does not respond
- :minimum: A string containing an integer that sets the :abbr:`TTL (Time To Live)` - in seconds - of the record for the purpose of negative caching
- :refresh: A string containing an integer that sets the number of seconds after which secondary name servers should query the master for the :abbr:`SOA (Start of Authority)` record, to detect zone changes
- :retry: A string containing an integer that sets the number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond
-
- .. note:: :rfc:`1035` dictates that this should always be less than ``refresh``.
-
- .. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.
-
- :sslEnabled: A string containing a boolean that tells whether this :term:`Delivery Service` uses SSL; one of:
-
- "false"
- SSL is not used by this :term:`Delivery Service`
- "true"
- SSL is used by this :term:`Delivery Service`
-
- .. seealso:: :ref:`ds-protocol`
-
- :ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
-
- .. note:: This overrides ``config.ttls``.
-
-:edgeLocations: An object containing keys which are the names of Edge-Tier :term:`Cache Groups` within the CDN
-
- :backupLocations: An object that describes this :ref:`Cache Group's Fallbacks <cache-group-fallbacks>`
-
- :fallbackToClosest: A string containing a boolean which defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`; one of:
-
- "false"
- Do not fall back on the closest available :term:`Cache Group`
- "true"
- Fall back on the closest available :term:`Cache Group`
-
- :list: If this :term:`Cache Group` has any :ref:`cache-group-fallbacks`, this key will appear and will be an array of those :ref:`Cache Groups' Names <cache-group-name>`
-
- :latitude: A floating point number that defines this :ref:`Cache Group's Latitude <cache-group-latitude>`
- :localizationMethods: An array of strings that represents this :ref:`Cache Group's Localization Methods <cache-group-localization-methods>`
- :longitude: A floating point number that defines this :ref:`Cache Group's Longitude <cache-group-longitude>`
-
-:monitors: An object containing keys which are the (short) hostnames of Traffic Monitors within this CDN
-
- :fqdn: The :abbr:`FQDN (Fully Qualified Domain Name)` of this Traffic Monitor
- :httpsPort: The port number on which this Traffic Monitor listens for incoming HTTPS requests
- :ip6: This Traffic Monitor's IPv6 address
- :ip: This Traffic Monitor's IPv4 address
- :location: A string which is the :ref:`cache-group-name` of the :term:`Cache Group` to which this Traffic Monitor belongs
- :port: The port number on which this Traffic Monitor listens for incoming HTTP requests
- :profile: A string which is the :ref:`profile-name` of the :term:`Profile` used by this Traffic Monitor
-
- .. note:: For legacy reasons, this must always start with "RASCAL-".
-
- :status: The health status of this Traffic Monitor
-
- .. seealso:: :ref:`health-proto`
-
-:stats: An object containing metadata information regarding the CDN
-
- :CDN_name: The name of this CDN
- :date: The UNIX epoch timestamp date in the Traffic Ops server's own timezone
- :tm_host: The :abbr:`FQDN (Fully Qualified Domain Name)` of the Traffic Ops server
- :tm_path: A path relative to the root of the Traffic Ops server where a request may be replaced to have this :term:`Snapshot` overwritten by the current *configured state* of the CDN
-
- .. deprecated:: ATCv6
-
- This information should never be used; instead all tools and (especially) components **must** use the documented API. This field was removed in APIv4
-
- :tm_user: The username of the currently logged-in user
- :tm_version: The full version number of the Traffic Ops server, including release number, git commit hash, and supported Enterprise Linux version
-
-:trafficRouterLocations: An object containing keys which are the :ref:`names of Cache Groups <cache-group-name>` within the CDN which contain Traffic Routers
-
- :backupLocations: An object that describes this :ref:`Cache Group's Fallbacks <cache-group-fallbacks>`
-
- :fallbackToClosest: A string containing a boolean which defines this :ref:`Cache Group's Fallback to Closest <cache-group-fallback-to-closest>` setting; one of:
-
- "false"
- Do not fall back on the closest available :term:`Cache Group`
- "true"
- Fall back on the closest available :term:`Cache Group`
-
- :latitude: A floating point number that defines this :ref:`Cache Group's Latitude <cache-group-latitude>`
- :localizationMethods: An array of strings that represents this :ref:`Cache Group's Localization Methods <cache-group-localization-methods>`
- :longitude: A floating point number that defines this :ref:`Cache Group's Longitude <cache-group-longitude>`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 220bc4XXwaj+s7ODd3QAF5leGj06lnApiN5E8H/B2RgxSphnQIfnwy6WWbBDjonWXPV1IWDCjBMO+rR+lAabMg==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 12 Dec 2018 17:36:25 GMT
- Transfer-Encoding: chunked
-
- { "response": {
- "config": {
- "api.cache-control.max-age": "10",
- "certificates.polling.interval": "300000",
- "consistent.dns.routing": "true",
- "coveragezone.polling.interval": "3600000",
- "coveragezone.polling.url": "https://trafficops.infra.ciab.test:443/coverage-zone.json",
- "dnssec.dynamic.response.expiration": "300s",
- "dnssec.enabled": "false",
- "domain_name": "mycdn.ciab.test",
- "federationmapping.polling.interval": "60000",
- "federationmapping.polling.url": "https://${toHostname}/api/1.5/federations/all",
- "geolocation.polling.interval": "86400000",
- "geolocation.polling.url": "https://trafficops.infra.ciab.test:443/GeoLite2-City.mmdb.gz",
- "keystore.maintenance.interval": "300",
- "neustar.polling.interval": "86400000",
- "neustar.polling.url": "https://trafficops.infra.ciab.test:443/neustar.tar.gz",
- "soa": {
- "admin": "twelve_monkeys",
- "expire": "604800",
- "minimum": "30",
- "refresh": "28800",
- "retry": "7200"
- },
- "steeringmapping.polling.interval": "60000",
- "ttls": {
- "A": "3600",
- "AAAA": "3600",
- "DNSKEY": "30",
- "DS": "30",
- "NS": "3600",
- "SOA": "86400"
- },
- "zonemanager.cache.maintenance.interval": "300",
- "zonemanager.threadpool.scale": "0.50"
- },
- "contentServers": {
- "edge": {
- "cacheGroup": "CDN_in_a_Box_Edge",
- "fqdn": "edge.infra.ciab.test",
- "hashCount": 999,
- "hashId": "edge",
- "httpsPort": 443,
- "interfaceName": "eth0",
- "ip": "172.16.239.100",
- "ip6": "fc01:9400:1000:8::100",
- "locationId": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "ATS_EDGE_TIER_CACHE",
- "status": "REPORTED",
- "type": "EDGE",
- "deliveryServices": {
- "demo1": [
- "edge.demo1.mycdn.ciab.test"
- ]
- },
- "routingDisabled": 0
- },
- "mid": {
- "cacheGroup": "CDN_in_a_Box_Mid",
- "fqdn": "mid.infra.ciab.test",
- "hashCount": 999,
- "hashId": "mid",
- "httpsPort": 443,
- "interfaceName": "eth0",
- "ip": "172.16.239.120",
- "ip6": "fc01:9400:1000:8::120",
- "locationId": "CDN_in_a_Box_Mid",
- "port": 80,
- "profile": "ATS_MID_TIER_CACHE",
- "status": "REPORTED",
- "type": "MID",
- "routingDisabled": 0
- }
- },
- "contentRouters": {
- "trafficrouter": {
- "api.port": "3333",
- "secure.api.port": "3443",
- "fqdn": "trafficrouter.infra.ciab.test",
- "httpsPort": 443,
- "ip": "172.16.239.60",
- "ip6": "fc01:9400:1000:8::60",
- "location": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "CCR_CIAB",
- "status": "ONLINE"
- }
- },
- "deliveryServices": {
- "demo1": {
- "anonymousBlockingEnabled": "false",
- "coverageZoneOnly": "false",
- "dispersion": {
- "limit": 1,
- "shuffled": "true"
- },
- "domains": [
- "demo1.mycdn.ciab.test"
- ],
- "geolocationProvider": "maxmindGeolocationService",
- "matchsets": [
- {
- "protocol": "HTTP",
- "matchlist": [
- {
- "regex": ".*\\.demo1\\..*",
- "match-type": "HOST"
- }
- ]
- }
- ],
- "missLocation": {
- "lat": 42,
- "long": -88
- },
- "protocol": {
- "acceptHttps": "false",
- "redirectToHttps": "false"
- },
- "regionalGeoBlocking": "false",
- "soa": {
- "admin": "traffic_ops",
- "expire": "604800",
- "minimum": "30",
- "refresh": "28800",
- "retry": "7200"
- },
- "sslEnabled": "false",
- "ttls": {
- "A": "",
- "AAAA": "",
- "NS": "3600",
- "SOA": "86400"
- },
- "ip6RoutingEnabled": "true",
- "ecsEnabled": "false",
- "routingName": "video",
- "deepCachingType": "NEVER"
- }
- },
- "edgeLocations": {
- "CDN_in_a_Box_Edge": {
- "latitude": 38.897663,
- "longitude": -77.036574,
- "backupLocations": {
- "fallbackToClosest": "true"
- },
- "localizationMethods": [
- "GEO",
- "CZ",
- "DEEP_CZ"
- ]
- }
- },
- "trafficRouterLocations": {
- "CDN_in_a_Box_Edge": {
- "latitude": 38.897663,
- "longitude": -77.036574,
- "backupLocations": {
- "fallbackToClosest": "false"
- },
- "localizationMethods": [
- "GEO",
- "CZ",
- "DEEP_CZ"
- ]
- }
- },
- "monitors": {
- "trafficmonitor": {
- "fqdn": "trafficmonitor.infra.ciab.test",
- "httpsPort": 443,
- "ip": "172.16.239.40",
- "ip6": "fc01:9400:1000:8::40",
- "location": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "RASCAL-Traffic_Monitor",
- "status": "ONLINE"
- }
- },
- "stats": {
- "CDN_name": "CDN-in-a-Box",
- "date": 1544635937,
- "tm_host": "trafficops.infra.ciab.test",
- "tm_path": "/api/1.2/snapshot/CDN-in-a-Box",
- "tm_user": "admin",
- "tm_version": "traffic_ops-3.0.0-9813.8ad7bd8e.el7"
- }
- }}
-
-.. [#httpOnly] These only apply to HTTP-:ref:`routed <ds-types>` :term:`Delivery Services`
diff --git a/docs/source/api/v1/cdns_name_snapshot_new.rst b/docs/source/api/v1/cdns_name_snapshot_new.rst
deleted file mode 100644
index 34c5e98..0000000
--- a/docs/source/api/v1/cdns_name_snapshot_new.rst
+++ /dev/null
@@ -1,556 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-name-snapshot-new:
-
-******************************
-``cdns/{{name}}/snapshot/new``
-******************************
-
-``GET``
-=======
-Retrieves the *pending* :term:`Snapshot` for a CDN, which represents the current *configuration* of the CDN, **not** the current *operating state* of the CDN. The contents of this :term:`Snapshot` are currently used by Traffic Monitor and Traffic Router.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +------+--------------------------------------------------------------------+
- | Name | Description |
- +======+====================================================================+
- | name | The name of the CDN for which a :term:`Snapshot` shall be returned |
- +------+--------------------------------------------------------------------+
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/cdns/CDN-in-a-Box/snapshot/new HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:config: An object containing basic configurations on the actual CDN object
-
- :api.cache-control.max-age: A string containing an integer which specifies the value of ``max-age`` in the :mailheader:`Cache-Control` header of some HTTP responses, likely the :ref:`tr-api` responses
- :certificates.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for updated SSL certificates
- :consistent.dns.routing: A string containing a boolean which indicates whether DNS routing will use a consistent hashing method or "round-robin"
-
- "false"
- The "round-robin" method will be used to define DNS routing
- "true"
- A consistent hashing method will be used to define DNS routing
-
- :coveragezone.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should check for a new Coverage Zone file
- :coveragezone.polling.url: The URL where a :term:`Coverage Zone File` may be requested by Traffic Routers
- :dnssec.dynamic.response.expiration: A string containing a number and unit suffix that specifies the length of time for which dynamic responses to DNSSEC lookup queries should remain valid
- :dnssec.dynamic.concurrencylevel: An integer that defines the size of the concurrency level (threads) of the Guava cache used by ZoneManager to store zone material
- :dnssec.dynamic.initialcapacity: An integer that defines the initial size of the Guava cache, default is 10000. Too low of a value can lead to expensive resizing
- :dnssec.init.timeout: An integer that defines the number of minutes to allow for zone generation, this bounds the zone priming activity
- :dnssec.enabled: A string that tells whether or not the CDN uses DNSSEC; one of:
-
- "false"
- DNSSEC is not used within this CDN
- "true"
- DNSSEC is used within this CDN
-
- :domain_name: A string that is the :abbr:`TLD (Top-Level Domain)` served by the CDN
- :federationmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new federation mappings
- :federationmapping.polling.url: The URL where Traffic Control components can request federation mappings
- :geolocation.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
- :geolocation.polling.url: The URL where Traffic Control components can request IP-to-geographic-location mapping database files
- :keystore.maintenance.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should refresh their zone caches
- :neustar.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new "Neustar" databases
- :neustar.polling.url: The URL where Traffic Control components can request "Neustar" databases
- :soa: An object defining the :abbr:`SOA (Start of Authority)` for the CDN's :abbr:`TLD (Top-Level Domain)` (defined in ``domain_name``)
-
- :admin: The name of the administrator for this zone - i.e. the RNAME
-
- .. note:: This rarely represents a proper email address, unfortunately.
-
- :expire: A string containing an integer that sets the number of seconds after which secondary name servers should stop answering requests for this zone if the master does not respond
- :minimum: A string containing an integer that sets the :abbr:`TTL (Time To Live)` - in seconds - of the record for the purpose of negative caching
- :refresh: A string containing an integer that sets the number of seconds after which secondary name servers should query the master for the :abbr:`SOA (Start of Authority)` record, to detect zone changes
- :retry: A string containing an integer that sets the number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond
-
- .. note:: :rfc:`1035` dictates that this should always be less than ``refresh``.
-
- .. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.
-
- :steeringmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Control components should check for new steering mappings
- :ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
- :zonemanager.cache.maintenance.interval: A configuration option for the ZoneManager Java class of Traffic Router
- :zonemanager.threadpool.scale: A configuration option for the ZoneManager Java class of Traffic Router
-
-:contentRouters: An object containing keys which are the (short) hostnames of the Traffic Routers that serve requests for :term:`Delivery Services` in this CDN
-
- :api.port: A string containing the port number on which the :ref:`tr-api` is served by this Traffic Router via HTTP
- :secure.api.port: An optionally present string containing the port number on which the :ref:`tr-api` is served by this Traffic Router via HTTPS
- :fqdn: This Traffic Router's :abbr:`FQDN (Fully Qualified Domain Name)`
- :httpsPort: The port number on which this Traffic Router listens for incoming HTTPS requests
- :ip: This Traffic Router's IPv4 address
- :ip6: This Traffic Router's IPv6 address
- :location: A string which is the :ref:`cache-group-name` of the :term:`Cache Group` to which this Traffic Router belongs
- :port: The port number on which this Traffic Router listens for incoming HTTP requests
- :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Router
- :status: The health status of this Traffic Router
-
- .. seealso:: :ref:`health-proto`
-
-:contentServers: An object containing keys which are the (short) hostnames of the :term:`Edge-tier cache servers` in the CDN; the values corresponding to those keys are routing information for said servers
-
- :cacheGroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` to which the server belongs
- :deliveryServices: An object containing keys which are the names of :term:`Delivery Services` to which this :term:`cache server` is assigned; the values corresponding to those keys are arrays of :abbr:`FQDNs (Fully Qualified Domain Names)` that resolve to this :term:`cache server`
-
- .. note:: Only :term:`Edge-tier cache servers` can be assigned to a :term:`Delivery Service`, and therefore this field will only be present when ``type`` is ``"EDGE"``.
-
- :fqdn: The server's :abbr:`FQDN (Fully Qualified Domain Name)`
- :hashCount: The number of servers to be placed into a single "hash ring" in Traffic Router
- :hashId: A unique string to be used as the key for hashing servers - as of version 3.0.0 of Traffic Control, this is always the same as the server's (short) hostname and only still exists for legacy compatibility reasons
- :httpsPort: The port on which the :term:`cache server` listens for incoming HTTPS requests
- :interfaceName: The name of the main network interface device used by this :term:`cache server`
- :ip6: The server's IPv6 address
- :ip: The server's IPv4 address
- :locationId: This field is exactly the same as ``cacheGroup`` and only exists for legacy compatibility reasons
- :port: The port on which this :term:`cache server` listens for incoming HTTP requests
- :profile: The :ref:`profile-name` of the :term:`Profile` used by the :term:`cache server`
- :routingDisabled: An integer representing the boolean concept of whether or not Traffic Routers should route client traffic to this :term:`cache server`; one of:
-
- 0
- Do not route traffic to this server
- 1
- Route traffic to this server normally
-
- :status: This :term:`cache server`'s status
-
- .. seealso:: :ref:`health-proto`
-
- :type: The :term:`Type` of this :term:`cache server`; which ought to be one of (but in practice need not be in certain special circumstances):
-
- EDGE
- This is an :term:`Edge-tier cache server`
- MID
- This is a :term:`Mid-tier cache server`
-
-:deliveryServices: An object containing keys which are the :ref:`xml_ids <ds-xmlid>` of all of the :term:`Delivery Services` within the CDN
-
- :anonymousBlockingEnabled: A string containing a boolean that tells whether or not :ref:`ds-anonymous-blocking` is set on this :term:`Delivery Service`; one of:
-
- "true"
- Anonymized IP addresses are blocked by this :term:`Delivery Service`
- "false"
- Anonymized IP addresses are not blocked by this :term:`Delivery Service`
-
- .. seealso:: :ref:`anonymous_blocking-qht`
-
- :consistentHashQueryParameters: A set of query parameters that Traffic Router should consider when determining a consistent hash for a given client request.
-
- .. versionadded:: ATCv4
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- :consistentHashRegex: An optional regular expression that will ensure clients are consistently routed to a :term:`cache server` based on matches to it.
-
- .. versionadded:: ATCv4
- This field was added to all versions of this endpoint with :abbr:`ATC (Apache Traffic Control)` version 4.0.
-
- :coverageZoneOnly: A string containing a boolean that tells whether or not this :term:`Delivery Service` routes traffic based only on its :term:`Coverage Zone File`
-
- .. seealso:: :ref:`ds-geo-limit`
-
- :deepCachingType: A string that defines the :ref:`ds-deep-caching` setting of this :term:`Delivery Service`
- :dispersion: An object describing the "dispersion" - or number of :term:`cache servers` within a single :term:`Cache Group` across which the same content is spread - within the :term:`Delivery Service`
-
- :limit: The maximum number of :term:`cache servers` in which the response to a single request URL will be stored
-
- .. note:: If this is greater than the number of :term:`cache servers` in the :term:`Cache Group` chosen to service the request, then content will be spread across all of them. That is, it causes no problems.
-
- :shuffled: A string containing a boolean that tells whether the :term:`cache servers` chosen for content dispersion are chosen randomly or based on a consistent hash of the request URL; one of:
-
- "false"
- :term:`cache servers` will be chosen consistently
- "true"
- :term:`cache servers` will be chosen at random
-
- :domains: An array of domains served by this :term:`Delivery Service`
- :ecsEnabled: A string containing a boolean from :ref:`ds-ecs` that tells whether EDNS0 client subnet is enabled on this :term:`Delivery Service`; one of:
-
- "false"
- EDNS0 client subnet is not enabled on this :term:`Delivery Service`
- "true"
- EDNS0 client subnet is enabled on this :term:`Delivery Service`
-
- :geolocationProvider: The name of a provider for IP-to-geographic-location mapping services - currently the only valid value is ``"maxmindGeolocationService"``
- :ip6RoutingEnabled: A string containing a boolean that defines the :ref:`ds-ipv6-routing` setting for this :term:`Delivery Service`; one of:
-
- "false"
- IPv6 traffic will not be routed by this :term:`Delivery Service`
- "true"
- IPv6 traffic will be routed by this :term:`Delivery Service`
-
- :matchList: An array of methods used by Traffic Router to determine whether or not a request can be serviced by this :term:`Delivery Service`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integral, unique identifier for the set of types to which the ``type`` field belongs
- :type: The name of the :term:`Type` of match performed using ``pattern`` to determine whether or not to use this :term:`Delivery Service`
-
- HOST_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the :mailheader:`Host` HTTP header of an HTTP request, or the name requested for resolution in a DNS request
- HEADER_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches an HTTP header (both the name and value) in an HTTP request\ [#httpOnly]_
- PATH_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the request path of this :term:`Delivery Service`'s URL\ [#httpOnly]_
- STEERING_REGEXP
- Use the :term:`Delivery Service` if ``pattern`` matches the :ref:`ds-xmlid` of one of this :term:`Delivery Service`'s "Steering" target :term:`Delivery Services`
-
- :missLocation: An object representing the default geographic coordinates to use for a client when lookup of their IP has failed in both the :term:`Coverage Zone File` (and/or possibly the :term:`Deep Coverage Zone File`) and the IP-to-geographic-location database
-
- :lat: Geographic latitude as a floating point number
- :long: Geographic longitude as a floating point number
-
- :protocol: An object that describes how the :term:`Delivery Service` ought to handle HTTP requests both with and without TLS encryption
-
- :acceptHttps: A string containing a boolean that tells whether HTTPS requests should be normally serviced by this :term:`Delivery Service`; one of:
-
- "false"
- Refuse to service HTTPS requests
- "true"
- Service HTTPS requests normally
-
- :redirectToHttps: A string containing a boolean that tells whether HTTP requests ought to be re-directed to use HTTPS; one of:
-
- "false"
- Do not redirect unencrypted traffic; service it normally
- "true"
- Respond to HTTP requests with instructions to use HTTPS instead
-
- .. seealso:: :ref:`ds-protocol`
-
- :regionalGeoBlocking: A string containing a boolean that defines the :ref:`ds-regionalgeo` setting of this :term:`Delivery Service`; one of:
-
- "false"
- Regional Geographic Blocking is not used by this :term:`Delivery Service`
- "true"
- Regional Geographic Blocking is used by this :term:`Delivery Service`
-
- .. seealso:: :ref:`regionalgeo-qht`
-
- :routingName: A string that is this :ref:`Delivery Service's Routing Name <ds-routing-name>`
- :soa: An object defining the :abbr:`SOA (Start of Authority)` record for the :term:`Delivery Service`'s :abbr:`TLDs (Top-Level Domains)` (defined in ``domains``)
-
- :admin: The name of the administrator for this zone - i.e. the RNAME
-
- .. note:: This rarely represents a proper email address, unfortunately.
-
- :expire: A string containing an integer that sets the number of seconds after which secondary name servers should stop answering requests for this zone if the master does not respond
- :minimum: A string containing an integer that sets the :abbr:`TTL (Time To Live)` - in seconds - of the record for the purpose of negative caching
- :refresh: A string containing an integer that sets the number of seconds after which secondary name servers should query the master for the :abbr:`SOA (Start of Authority)` record, to detect zone changes
- :retry: A string containing an integer that sets the number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond
-
- .. note:: :rfc:`1035` dictates that this should always be less than ``refresh``.
-
- .. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.
-
- :sslEnabled: A string containing a boolean that tells whether this :term:`Delivery Service` uses SSL; one of:
-
- "false"
- SSL is not used by this :term:`Delivery Service`
- "true"
- SSL is used by this :term:`Delivery Service`
-
- .. seealso:: :ref:`ds-protocol`
-
- :ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
-
- .. note:: This overrides ``config.ttls``.
-
-:edgeLocations: An object containing keys which are the names of Edge-Tier :term:`Cache Groups` within the CDN
-
- :backupLocations: An object that describes this :ref:`Cache Group's Fallbacks <cache-group-fallbacks>`
-
- :fallbackToClosest: A string containing a boolean which defines the :ref:`cache-group-fallback-to-closest` behavior of this :term:`Cache Group`; one of:
-
- "false"
- Do not fall back on the closest available :term:`Cache Group`
- "true"
- Fall back on the closest available :term:`Cache Group`
-
- :list: If this :term:`Cache Group` has any :ref:`cache-group-fallbacks`, this key will appear and will be an array of those :ref:`Cache Groups' Names <cache-group-name>`
-
- :latitude: A floating point number that defines this :ref:`Cache Group's Latitude <cache-group-latitude>`
- :localizationMethods: An array of strings that represents this :ref:`Cache Group's Localization Methods <cache-group-localization-methods>`
- :longitude: A floating point number that defines this :ref:`Cache Group's Longitude <cache-group-longitude>`
-
-:monitors: An object containing keys which are the (short) hostnames of Traffic Monitors within this CDN
-
- :fqdn: The :abbr:`FQDN (Fully Qualified Domain Name)` of this Traffic Monitor
- :httpsPort: The port number on which this Traffic Monitor listens for incoming HTTPS requests
- :ip6: This Traffic Monitor's IPv6 address
- :ip: This Traffic Monitor's IPv4 address
- :location: A string which is the :ref:`cache-group-name` of the :term:`Cache Group` to which this Traffic Monitor belongs
- :port: The port number on which this Traffic Monitor listens for incoming HTTP requests
- :profile: A string which is the :ref:`profile-name` of the :term:`Profile` used by this Traffic Monitor
-
- .. note:: For legacy reasons, this must always start with "RASCAL-".
-
- :status: The health status of this Traffic Monitor
-
- .. seealso:: :ref:`health-proto`
-
-:stats: An object containing metadata information regarding the CDN
-
- :CDN_name: The name of this CDN
- :date: The UNIX epoch timestamp date in the Traffic Ops server's own timezone
- :tm_host: The :abbr:`FQDN (Fully Qualified Domain Name)` of the Traffic Ops server
- :tm_path: A path relative to the root of the Traffic Ops server where a request may be replaced to have this :term:`Snapshot` overwritten by the current *configured state* of the CDN
-
- .. deprecated:: ATCv6
-
- This information should never be used; instead all tools and (especially) components **must** use the documented API. This field was removed in APIv4
-
- :tm_user: The username of the currently logged-in user
- :tm_version: The full version number of the Traffic Ops server, including release number, git commit hash, and supported Enterprise Linux version
-
-:trafficRouterLocations: An object containing keys which are the :ref:`names of Cache Groups <cache-group-name>` within the CDN which contain Traffic Routers
-
- :backupLocations: An object that describes this :ref:`Cache Group's Fallbacks <cache-group-fallbacks>`
-
- :fallbackToClosest: A string containing a boolean which defines this :ref:`Cache Group's Fallback to Closest <cache-group-fallback-to-closest>` setting; one of:
-
- "false"
- Do not fall back on the closest available :term:`Cache Group`
- "true"
- Fall back on the closest available :term:`Cache Group`
-
- :latitude: A floating point number that defines this :ref:`Cache Group's Latitude <cache-group-latitude>`
- :localizationMethods: An array of strings that represents this :ref:`Cache Group's Localization Methods <cache-group-localization-methods>`
- :longitude: A floating point number that defines this :ref:`Cache Group's Longitude <cache-group-longitude>`
-
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: MWzgAYngmU1IEIxRa0C6VfY+MMuu7T9OCiIj1Aul58pA7J7DiS6r8wjVRVVW8W2Eu2V9BC7OEacR1fQyuIsRWg==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 12 Dec 2018 21:41:48 GMT
- Transfer-Encoding: chunked
-
- { "response": {
- "config": {
- "api.cache-control.max-age": "10",
- "certificates.polling.interval": "300000",
- "consistent.dns.routing": "true",
- "coveragezone.polling.interval": "3600000",
- "coveragezone.polling.url": "https://trafficops.infra.ciab.test:443/coverage-zone.json",
- "dnssec.dynamic.response.expiration": "300s",
- "dnssec.enabled": "false",
- "domain_name": "mycdn.ciab.test",
- "federationmapping.polling.interval": "60000",
- "federationmapping.polling.url": "https://${toHostname}/api/1.5/federations/all",
- "geolocation.polling.interval": "86400000",
- "geolocation.polling.url": "https://trafficops.infra.ciab.test:443/GeoLite2-City.mmdb.gz",
- "keystore.maintenance.interval": "300",
- "neustar.polling.interval": "86400000",
- "neustar.polling.url": "https://trafficops.infra.ciab.test:443/neustar.tar.gz",
- "soa": {
- "admin": "twelve_monkeys",
- "expire": "604800",
- "minimum": "30",
- "refresh": "28800",
- "retry": "7200"
- },
- "steeringmapping.polling.interval": "60000",
- "ttls": {
- "A": "3600",
- "AAAA": "3600",
- "DNSKEY": "30",
- "DS": "30",
- "NS": "3600",
- "SOA": "86400"
- },
- "zonemanager.cache.maintenance.interval": "300",
- "zonemanager.threadpool.scale": "0.50"
- },
- "contentServers": {
- "edge": {
- "cacheGroup": "CDN_in_a_Box_Edge",
- "fqdn": "edge.infra.ciab.test",
- "hashCount": 999,
- "hashId": "edge",
- "httpsPort": 443,
- "interfaceName": "eth0",
- "ip": "172.16.239.100",
- "ip6": "fc01:9400:1000:8::100",
- "locationId": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "ATS_EDGE_TIER_CACHE",
- "status": "REPORTED",
- "type": "EDGE",
- "deliveryServices": {
- "demo1": [
- "edge.demo1.mycdn.ciab.test"
- ]
- },
- "routingDisabled": 0
- },
- "mid": {
- "cacheGroup": "CDN_in_a_Box_Mid",
- "fqdn": "mid.infra.ciab.test",
- "hashCount": 999,
- "hashId": "mid",
- "httpsPort": 443,
- "interfaceName": "eth0",
- "ip": "172.16.239.120",
- "ip6": "fc01:9400:1000:8::120",
- "locationId": "CDN_in_a_Box_Mid",
- "port": 80,
- "profile": "ATS_MID_TIER_CACHE",
- "status": "REPORTED",
- "type": "MID",
- "routingDisabled": 0
- }
- },
- "contentRouters": {
- "trafficrouter": {
- "api.port": "3333",
- "secure.api.port": "3443",
- "fqdn": "trafficrouter.infra.ciab.test",
- "httpsPort": 443,
- "ip": "172.16.239.60",
- "ip6": "fc01:9400:1000:8::60",
- "location": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "CCR_CIAB",
- "status": "ONLINE"
- }
- },
- "deliveryServices": {
- "demo1": {
- "anonymousBlockingEnabled": "false",
- "coverageZoneOnly": "false",
- "dispersion": {
- "limit": 1,
- "shuffled": "true"
- },
- "domains": [
- "demo1.mycdn.ciab.test"
- ],
- "geolocationProvider": "maxmindGeolocationService",
- "matchsets": [
- {
- "protocol": "HTTP",
- "matchlist": [
- {
- "regex": ".*\\.demo1\\..*",
- "match-type": "HOST"
- }
- ]
- }
- ],
- "missLocation": {
- "lat": 42,
- "long": -88
- },
- "protocol": {
- "acceptHttps": "false",
- "redirectToHttps": "false"
- },
- "regionalGeoBlocking": "false",
- "soa": {
- "admin": "traffic_ops",
- "expire": "604800",
- "minimum": "30",
- "refresh": "28800",
- "retry": "7200"
- },
- "sslEnabled": "false",
- "ttls": {
- "A": "",
- "AAAA": "",
- "NS": "3600",
- "SOA": "86400"
- },
- "ip6RoutingEnabled": "true",
- "ecsEnabled": "false",
- "routingName": "video",
- "deepCachingType": "NEVER"
- }
- },
- "edgeLocations": {
- "CDN_in_a_Box_Edge": {
- "latitude": 38.897663,
- "longitude": -77.036574,
- "backupLocations": {
- "fallbackToClosest": "true",
- "list": [
- "test"
- ]
- },
- "localizationMethods": [
- "GEO",
- "CZ",
- "DEEP_CZ"
- ]
- }
- },
- "trafficRouterLocations": {
- "CDN_in_a_Box_Edge": {
- "latitude": 38.897663,
- "longitude": -77.036574,
- "backupLocations": {
- "fallbackToClosest": "false"
- },
- "localizationMethods": [
- "GEO",
- "CZ",
- "DEEP_CZ"
- ]
- }
- },
- "monitors": {
- "trafficmonitor": {
- "fqdn": "trafficmonitor.infra.ciab.test",
- "httpsPort": 443,
- "ip": "172.16.239.40",
- "ip6": "fc01:9400:1000:8::40",
- "location": "CDN_in_a_Box_Edge",
- "port": 80,
- "profile": "RASCAL-Traffic_Monitor",
- "status": "ONLINE"
- }
- },
- "stats": {
- "CDN_name": "CDN-in-a-Box",
- "date": 1544650908,
- "tm_host": "ipcdn-cache-51.cdnlab.comcast.net:6443",
- "tm_path": "/api/1.2/snapshot/CDN-in-a-Box",
- "tm_user": "admin",
- "tm_version": "traffic_ops-3.0.0-9813.8ad7bd8e.el7"
- }
- }}
-
-.. [#httpOnly] These only apply to HTTP-:ref:`routed <ds-types>` :term:`Delivery Services`
diff --git a/docs/source/api/v1/cdns_routing.rst b/docs/source/api/v1/cdns_routing.rst
deleted file mode 100644
index f77ef3a..0000000
--- a/docs/source/api/v1/cdns_routing.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-routing:
-
-****************
-``cdns/routing``
-****************
-
-``GET``
-=======
-Retrieves the aggregated routing percentages across all CDNs. This is accomplished by polling stats from all online Traffic Routers via the ``/crs/stats`` route.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-No parameters available
-
-Response Structure
-------------------
-:cz: The percent of requests to online Traffic Routers that were satisfied by a :term:`Coverage Zone File`
-:deepCz: The percent of requests to online Traffic Routers that were satisfied by a :term:`Deep Coverage Zone File`
-:dsr: The percent of requests to online Traffic Routers that were satisfied by sending the client to an overflow :term:`Delivery Service`
-:err: The percent of requests to online Traffic Routers that resulted in an error
-:fed: The percent of requests to online Traffic Routers that were satisfied by sending the client to a federated CDN
-:geo: The percent of requests to online Traffic Routers that were satisfied using 3rd party geographic IP mapping
-:miss: The percent of requests to online Traffic Routers that could not be satisfied
-:regionalAlternate: The percent of requests to online Traffic Routers that were satisfied by sending the client to the alternate, Regional Geo-blocking URL
-:regionalDenied: The percent of requests to online Traffic Routers that were denied due to geographic location policy
-:staticRoute: The percent of requests to online Traffic Routers that were satisfied with :ref:`ds-static-dns-entries`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 21:29:32 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: 7LjytwKyRzSKM4cRIol4OMIJxApFpTWJaSK73rbtUIQdASZjI64XxLVzZP0OGRU7XeJ22YKUyQ30qbKHDRv7FQ==
- Content-Length: 130
-
- { "response": {
- "cz": 79,
- "deepCz": 0.50,
- "dsr": 0,
- "err": 0,
- "fed": 0.25,
- "geo": 20,
- "miss": 0.25,
- "regionalAlternate": 0,
- "regionalDenied": 0,
- "staticRoute": 0
- }}
diff --git a/docs/source/api/v1/cdns_usage_overview.rst b/docs/source/api/v1/cdns_usage_overview.rst
deleted file mode 100644
index 3844cce..0000000
--- a/docs/source/api/v1/cdns_usage_overview.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-cdns-usage-overview:
-
-***********************
-``cdns/usage/overview``
-***********************
-
-.. versionadded:: 1.2
-
-.. deprecated:: ATCv4
- This endpoint and its functionality is deprecated, and will be removed in the future.
-
-``GET``
-=======
-Retrieves the high-level CDN usage metrics from Traffic Stats
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-No parameters available.
-
-Response Structure
-------------------
-:currentGbps: The current throughput of all CDNs, in Gigabits per second
-:maxGbps: The all-time maximum throughput of all CDNs, in Gigabits per second
-:source: The name of the service providing the statistics. This will almost always be "TrafficStats"
-:tps: The number of transactions being performed per second
-:version: The version of the service providing the statistics (named in ``"source"``)
-
-.. warning:: The ``"tps"`` field is currently broken, and will return ``0`` every time. See `GitHub issue #1020 <https://github.com/apache/trafficcontrol/issues/1020>`_ for more information.
-
-.. code-block:: json
- :caption: Response Example
-
- {
- "alerts": [
- {
- "level": "warning",
- "text": "This endpoint and its functionality is deprecated, and will be removed in the future"
- }
- ],
- "response": {
- "currentGbps": 975.920621333333,
- "source": "TrafficStats",
- "tps": 0,
- "version": "1.2",
- "maxGbps": 12085
- }
- }
diff --git a/docs/source/api/v1/consistenthash.rst b/docs/source/api/v1/consistenthash.rst
deleted file mode 100644
index 553c6a4..0000000
--- a/docs/source/api/v1/consistenthash.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-consistenthash:
-
-******************
-``consistenthash``
-******************
-Test Pattern-Based Consistent Hashing for a :term:`Delivery Service` using a regular expression and a request path
-
-``POST``
-========
-Queries database for an active Traffic Router on a given CDN and sends GET request to get the resulting path to consistent hash with a given regex and request path.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Object
-
-Request Structure
------------------
-:regex: The regular expression to apply to the request path to get a resulting path that will be used for consistent hashing
-:requestPath: The request path to use to test the regular expression against
-:cdnId: The unique identifier of a CDN that will be used to query for an active Traffic Router
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/consistenthash HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.54.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 80
- Content-Type: application/x-www-form-urlencoded
-
- {"regex":"/.*?(/.*?/).*?(m3u8)","requestPath":"/test/path/asset.m3u8","cdnId":2}
-
-Response Structure
-------------------
-:resultingPathToConsistentHash: The resulting path that Traffic Router will use for consistent hashing
-:consistentHashRegex: The regex used by Traffic Router derived from POST 'regex' parameter
-:requestPath: The request path used by Traffic Router to test regex against
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: QMDFOnUfqH4TcZ4YnUQyqnXDier0YiUMIfwBGDcT7ySjw9uASBGsLQW35lpnKFi4as0vYlHuSSGpe4hHGsladQ==
- X-Server-Name: traffic_ops_golang/
- Date: Tue, 12 Feb 2019 21:32:05 GMT
- Content-Length: 142
-
- { "response": {
- "resultingPathToConsistentHash":"/path/m3u8",
- "consistentHashRegex":"/.*?(/.*?/).*?(m3u8)",
- "requestPath":"/test/path/asset.m3u8"
- }}
diff --git a/docs/source/api/v1/coordinates.rst b/docs/source/api/v1/coordinates.rst
deleted file mode 100644
index 8a59517..0000000
--- a/docs/source/api/v1/coordinates.rst
+++ /dev/null
@@ -1,308 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-coordinates:
-
-***************
-``coordinates``
-***************
-.. versionadded:: 1.3
-
-``GET``
-=======
-Gets a list of all coordinates in the Traffic Ops database
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +===========+==========+===============================================================================================================+
- | id | no | Return only coordinates that have this integral, unique identifier |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | name | no | Return only coordinates with this name |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | | array |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long |
- | | | and the first page is 1. If ``offset`` was defined, this query parameter has no effect. ``limit`` must be |
- | | | defined to make use of ``page``. |
- +-----------+----------+---------------------------------------------------------------------------------------------------------------+
-
-Response Structure
-------------------
-:id: Integral, unique, identifier for this coordinate pair
-:lastUpdated: The time and date at which this entry was last updated, in a ``ctime``-like format
-:latitude: Latitude of the coordinate
-:longitude: Longitude of the coordinate
-:name: The name of the coordinate - typically this just reflects the name of the Cache Group for which the coordinate was created
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: Y2vxC3hpxIg6aRNBBT7i2hbAViIJp+dJoqHIzu3acFM+vGay/I5E+eZYOC9RY8hcJPrKNXysZOD8DOb9KsFgaw==
- X-Server-Name: traffic_ops_golang/
- Date: Wed, 14 Nov 2018 21:32:28 GMT
- Content-Length: 942
-
- { "response": [
- {
- "id": 1,
- "name": "from_cachegroup_TRAFFIC_ANALYTICS",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 2,
- "name": "from_cachegroup_TRAFFIC_OPS",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 3,
- "name": "from_cachegroup_TRAFFIC_OPS_DB",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 4,
- "name": "from_cachegroup_TRAFFIC_PORTAL",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 5,
- "name": "from_cachegroup_TRAFFIC_STATS",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 6,
- "name": "from_cachegroup_CDN_in_a_Box_Mid",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:04+00"
- },
- {
- "id": 7,
- "name": "from_cachegroup_CDN_in_a_Box_Edge",
- "latitude": 38.897663,
- "longitude": -77.036574,
- "lastUpdated": "2018-10-24 16:07:05+00"
- }
- ]}
-
-``POST``
-========
-Creates a new coordinate pair
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:name: The name of the new coordinate
-:latitude: The desired latitude of the new coordinate (must be on the interval [-180, 180])
-:longitude: The desired longitude of the new coordinate (must be on the interval [-90, 90])
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/coordinates HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 47
- Content-Type: application/json
-
- {"name": "test", "latitude": 0, "longitude": 0}
-
-Response Structure
-------------------
-:id: Integral, unique, identifier for the newly created coordinate pair
-:lastUpdated: The time and date at which this entry was last updated, in a ``ctime``-like format
-:latitude: Latitude of the newly created coordinate
-:longitude: Longitude of the newly created coordinate
-:name: The name of the coordinate
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 7pWdeZyIIXE1P7o/JVon+5eSCbDw+FGamAzdXzWHXJ8IhF+Vh+/tWFCkzHYw3rP2kBVwZu+gqLffjQpBCMjt7A==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 15 Nov 2018 17:48:55 GMT
- Content-Length: 165
-
- { "alerts": [
- {
- "text": "coordinate was created.",
- "level": "success"
- }
- ],
- "response": {
- "id": 9,
- "name": "test",
- "latitude": 0,
- "longitude": 0,
- "lastUpdated": "2018-11-15 17:48:55+00"
- }}
-
-
-``PUT``
-=======
-Updates a coordinate
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +------+----------+------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+============================================================+
- | id | yes | The integral, unique identifier of the coordinate to edit |
- +------+----------+------------------------------------------------------------+
-
-:name: The name of the new coordinate
-:latitude: The desired new latitude of the coordinate (must be on the interval [-180, 180])
-:longitude: The desired new longitude of the coordinate (must be on the interval [-90, 90])
-
-.. code-block:: http
- :caption: Request Example
-
- PUT /api/1.4/coordinates?id=9 HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 48
- Content-Type: application/json
-
- {"name": "quest", "latitude": 0, "longitude": 0}
-
-Response Structure
-------------------
-:id: Integral, unique, identifier for the coordinate pair
-:lastUpdated: The time and date at which this entry was last updated, in a ``ctime``-like format
-:latitude: Latitude of the coordinate
-:longitude: Longitude of the coordinate
-:name: The name of the coordinate
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: zd03Uvbnv8EbSZZ75Xp5tnnYStZsZTdyPxXnoqK4QZ5WhELLPL8iHlRfOaiLTbrUWUeJ8ue2HRz6aBS/iXCCGA==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 15 Nov 2018 17:54:30 GMT
- Content-Length: 166
-
- { "alerts": [
- {
- "text": "coordinate was updated.",
- "level": "success"
- }
- ],
- "response": {
- "id": 9,
- "name": "quest",
- "latitude": 0,
- "longitude": 0,
- "lastUpdated": "2018-11-15 17:54:30+00"
- }}
-
-``DELETE``
-==========
-Deletes a coordinate
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +------+----------+-------------------------------------------------------------+
- | Name | Required | Description |
- +======+==========+=============================================================+
- | id | yes | The integral, unique identifier of the coordinate to delete |
- +------+----------+-------------------------------------------------------------+
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: 82x/Wdckqgk4LN5LIlZfBJ26xkDrUVUGDjs5QFa/Lzap7dU3OZkjv8XW41xeFYj8PDmxHIpb7hiVObvLaxnEDA==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 15 Nov 2018 17:57:42 GMT
- Content-Length: 65
-
- { "alerts": [
- {
- "text": "coordinate was deleted.",
- "level": "success"
- }
- ]}
diff --git a/docs/source/api/v1/current_stats.rst b/docs/source/api/v1/current_stats.rst
deleted file mode 100644
index 0299106..0000000
--- a/docs/source/api/v1/current_stats.rst
+++ /dev/null
@@ -1,92 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v1-current-stats:
-
-*****************
-``current_stats``
-*****************
-An API endpoint that returns current statistics for each CDN and an aggregate across them all.
-
-.. versionadded:: 1.2
-
-``GET``
-=======
-Retrieves current stats for each CDN. Also includes aggregate stats across them.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-No parameters available.
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/current_stats HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-:cdn: The name of the CDN
-:connections: Current number of TCP connections maintained
-:capacity: 85 percent capacity of the CDN in Gps
-:bandwidth: The total amount of bandwidth in Gbs
-
-.. note:: If ``cdn`` name is total and capacity is omitted it represents the aggregate stats across CDNs
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=; Path=/; HttpOnly
- Whole-Content-Sha512: Rs3wgd7v5dP0bOQs4I3J1q6mnWIMSM2AKSAWirK1kymvDYOoFISArF7Kkypgy10I34yn7FtFdMh6U7ABaS1Tjw==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 14 Nov 2019 15:35:31 GMT
- Content-Length: 138
-
- {"response": {
- "currentStats": [
- {
- "bandwidth": null,
- "capacity": null,
- "cdn": "ALL",
- "connections": null
- },
- {
- "bandwidth": 0.000104,
- "capacity": 17,
- "cdn": "CDN-in-a-Box",
- "connections": 4
- },
- {
- "bandwidth": 0.000104,
- "cdn": "total",
- "connections": 4
- }
- ]
- }}
diff --git a/docs/source/api/v1/dbdump.rst b/docs/source/api/v1/dbdump.rst
deleted file mode 100644
index 589e1c1..0000000
--- a/docs/source/api/v1/dbdump.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-dbdump:
-
-**********
-``dbdump``
-**********
-.. caution:: This is an extremely dangerous thing to do, as it exposes the entirety of the database, including possibly sensitive information. Administrators and systems engineers are advised to instead use database-specific tools to make server transitions more securely.
-
-Dumps the Traffic Ops database as an SQL script that should recreate its schema and contents exactly.
-
-.. impl-detail:: The script is output using the :manpage:`pg_dump(1)` utility, and is thus compatible for use with the :manpage:`pg_restore(1)` utility.
-
-``GET``
-=======
-Fetches the database dump.
-
-:Auth. Required: Yes
-:Roles Required: "admin"
-:Response Type: ``undefined`` - outputs an SQL script, not JSON
-
-Request Structure
------------------
-No parameters available
-
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.4/dbdump HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/sql
- Content-Disposition: attachment
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: YwvPB0ZToyzT8ilBnDlWWdwV+E3f2Xgus1OKrkNaipQqgrw5zGwq0rC1U9TZ8Zl6kAGcRZgCYnr1EWfHXpJRkg==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 09 Sep 2019 21:08:28 GMT
- Transfer-Encoding: chunked
-
- -- Actual text omitted - it's huge
diff --git a/docs/source/api/v1/deliveryservice_server_dsid_serverid.rst b/docs/source/api/v1/deliveryservice_server_dsid_serverid.rst
deleted file mode 100644
index 4174df0..0000000
--- a/docs/source/api/v1/deliveryservice_server_dsid_serverid.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-deliveryservice_server-dsid-serverid:
-
-************************************************
-``deliveryservice_server/{{DSID}}/{{serverID}}``
-************************************************
-.. deprecated:: ATCv4
- Use the ``DELETE`` method of :ref:`to-api-deliveryserviceserver-dsid-serverid` instead.
-
-``DELETE``
-==========
-Removes a :term:`cache server` from a :term:`Delivery Service`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"\ [1]_
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +----------+----------+---------------------------------------------------------------+
- | Name | Required | Description |
- +==========+==========+===============================================================+
- | dsId | yes | An integral, unique identifier for a :term:`Delivery Service` |
- +----------+----------+---------------------------------------------------------------+
- | serverID | yes | An integral, unique identifier for a server |
- +----------+----------+---------------------------------------------------------------+
-
-.. note:: The server identified by ``serverID`` must be a :term:`cache server`, or the assignment will fail.
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: rGD2sOMHYF0sga1zuTytyLHCUkkc3ZwQRKvZ/HuPzObOP4WztKTOVXB4uhs3iJqBg9zRB2TucMxONHN+3/yShQ==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 01 Nov 2018 14:24:34 GMT
- Content-Length: 80
-
- { "alerts": [
- {
- "text": "Server unlinked from delivery service.",
- "level": "success"
- },
- {
- "text": "This endpoint is deprecated, please use DELETE deliveryserviceserver/:dsid/:serverid instead",
- "level": "warning"
- }
- ]}
-
-.. [1] Users with the "admin" or "operations" roles will be able to delete *any*:term:`Delivery Service`, whereas other users will only be able to delete :term:`Delivery Services` that their tenant has permissions to delete.
diff --git a/docs/source/api/v1/deliveryservice_stats.rst b/docs/source/api/v1/deliveryservice_stats.rst
deleted file mode 100644
index 5e62785..0000000
--- a/docs/source/api/v1/deliveryservice_stats.rst
+++ /dev/null
@@ -1,204 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v1-deliveryservice_stats:
-
-*************************
-``deliveryservice_stats``
-*************************
-.. versionadded:: 1.2
-
-.. danger:: The output of this endpoint can be confusing and/or misleading. Specifically, the response field ``totalBytes`` does **not** contain an amount in units of Bytes. See the field description for more information, or use :ref:`to-api-v2-deliveryservice_stats` for more intuitive response objects.
-
-``GET``
-=======
-Retrieves time-aggregated statistics on a specific :term:`Delivery Service`.
-
-:Auth. Required: Yes
-:Roles Required: None\ [#tenancy]_
-
- .. versionchanged:: ATCv4
- Prior to :abbr:`ATC (Apache Traffic Control)` version 4, this endpoint had more convoluted access requirements. The required :term:`Roles` for access were "operations" or "admin" - *unless* the :term:`Delivery Service` requested was "assigned" to the requesting user. In these older versions, Traffic Ops never checked the access to the :term:`Delivery Service`'s stats from a :term:`Tenant`-based perspective (which it now does) but instead used the legacy concept of "assigning" a :term:` [...]
-
-:Response Type: Object
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=====================+===================+===========================================================================================================================================================================================+
- | deliveryService | yes\ [#ds-param]_ | Either the :ref:`ds-xmlid` of a :term:`Delivery Service` for which statistics will be aggregated or the integral, unique identifier of said :term:`Delivery Service` |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | deliveryServiceName | yes\ [#ds-param]_ | The :ref:`ds-xmlid` of the :term:`Delivery Service` for which statistics will be aggregated |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | endDate | yes | The date and time until which statistics shall be aggregated in :rfc:`3339` format (with or without sub-second precision), the number of nanoseconds since the Unix |
- | | | Epoch, or in the same, proprietary format as the ``lastUpdated`` fields prevalent throughout the Traffic Ops API |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | exclude | no | Either "series" to omit the data series from the result, or "summary" to omit the summary data from the result - directly corresponds to fields in the |
- | | | `Response Structure`_ |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | interval | no | Specifies the interval within which data will be "bucketed"; e.g. when requesting data from 2019-07-25T00:00:00Z to 2019-07-25T23:59:59Z with an interval of "1m", |
- | | | the resulting data series (assuming it is not excluded) should contain |
- | | | :math:`24\frac{\mathrm{hours}}{\mathrm{day}}\times60\frac{\mathrm{minutes}}{\mathrm{hour}}\times1\mathrm{day}\times1\frac{\mathrm{minute}}{\mathrm{data point}}=1440\mathrm{data\;points}`|
- | | | The allowed values for this parameter are valid InfluxQL duration literal strings matching :regexp:`^\d+[mhdw]$` |
- | | | |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | limit | no | A natural number indicating the maximum amount of data points should be returned in the ``series`` object |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | metricType | yes | The metric type being reported - one of: |
- | | | |
- | | | kbps |
- | | | The total traffic rate in kilobytes per second served by the :term:`Delivery Service` |
- | | | tps_total |
- | | | The total traffic rate in transactions per second served by the :term:`Delivery Service` |
- | | | tps_2xx |
- | | | The total traffic rate in transactions per second serviced with 200-299 HTTP status codes |
- | | | tps_3xx |
- | | | The total traffic rate in transactions per second serviced with 300-399 HTTP status codes |
- | | | tps_4xx |
- | | | The total traffic rate in transactions per second serviced with 400-499 HTTP status codes |
- | | | tps_5xx |
- | | | The total traffic rate in transactions per second serviced with 500-599 HTTP status codes |
- | | | |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | offset | no | A natural number of data points to drop from the beginning of the returned data set |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Though one struggles to imagine why, this can be used to specify "time" to sort data points by their "time" (which is the default behavior) |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | startDate | yes | The date and time from which statistics shall be aggregated in :rfc:`3339` format (with or without sub-second precision), the number of nanoseconds since the Unix |
- | | | Epoch, or in the same, proprietary format as the ``lastUpdated`` fields prevalent throughout the Traffic Ops API |
- +---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. versionadded:: ATCv4
- The ``deliveryService`` query parameter was added to this endpoint in all API versions in version 4 of :abbr:`ATC (Apache Traffic Control)`.
-
-.. _deliveryservice_stats_v1-get-request-example:
-.. code-block:: http
- :caption: Request Example
-
- GET /api/1.3/deliveryservice_stats?deliveryServiceName=demo1&startDate=2019-07-22T17:55:00Z&endDate=2019-07-22T17:56:00.000Z&metricType=tps_total HTTP/1.1
- User-Agent: python-requests/2.20.1
- Accept-Encoding: gzip, deflate
- Accept: application/json;timestamp=unix, application/json;timestamp=rfc;q=0.9, application/json;q=0.8, */*;q=0.7
- Connection: keep-alive
- Cookie: mojolicious=...
-
-Content Format
-""""""""""""""
-It's important to note in :ref:`deliveryservice_stats_v1-get-request-example` the use of a complex "Accept" header. This endpoint accepts two special media types in the "Accept" header that instruct it on how to format the timestamps associated with the returned data. Specifically, Traffic Ops will recognize the special, optional, non-standard parameter of :mimetype:`application/json`: ``timestamp``. The values of this parameter are restricted to one of
-
-rfc
- Returned timestamps will be formatted according to :rfc:`3339` (no sub-second precision).
-unix
- Returned timestamps will be formatted as the number of nanoseconds since the Unix Epoch (midnight on January 1\ :sup:`st` 1970 UTC).
-
- .. impl-detail:: The endpoint passes back nanoseconds, specifically, because that is the form used both by InfluxDB, which is used to store the data being served, and Go's standard library. Clients may need to convert the value to match their own standard libraries - e.g. the :js:class:`Date` class in Javascript expects milliseconds.
-
-The default behavior - when only e.g. :mimetype:`application/json` or :mimetype:`*/*` is given - is to use :rfc:`3339` formatting. It will, however, respect quality parameters. It is suggested that clients request timestamps they can handle specifically, rather than relying on this default behavior, as it **is subject to change** and is in fact **expected to invert in the next major release** as string-based time formats become deprecated.
-
-.. seealso:: For more information on the "Accept" HTTP header, consult `its dedicated page on MDN <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept>`_.
-
-Response Structure
-------------------
-:series: An object containing the actual data series and information necessary for working with it.
-
- :columns: This is an array of names of the columns of the data contained in the "values" array - should always be ``["time", "sum_count"]``
- :count: The number of data points contained in the "values" array
- :name: The name of the data set. Should always match :samp:`{metric}.ds.1min` where ``metric`` is the requested ``metricType``
- :values: The actual array of data points. Each represents a length of time specified by the ``interval`` query parameter
-
- :time: The time at which the measurement was taken. This corresponds to the *beginning* of the interval. This time comes in the format of either an :rfc:`3339`-formatted string, or a number containing the number of nanoseconds since the Unix Epoch depending on the "Accept" header sent by the client, according to the rules outlined in `Content Format`_.
- :value: The value of the requested ``metricType`` at the time given by ``time``. This will always be a floating point number, unless no data is available for the data interval, in which case it will be ``null``
-
-:source: A legacy field meant only for plugins that override this endpoint to name themselves. Should always be "TrafficStats".
-
- .. deprecated:: 1.4
- As this has no known purpose, developers are advised it will be removed in the future.
-
-:summary: An object containing summary statistics describing the data series
-
- :average: The arithmetic mean of the data's values
- :count: The number of measurements taken within the requested timespan. This is, in general, **not** the same as the ``count`` field of the ``series`` object, as it reflects the number of underlying, un-"bucketed" data points, and is therefore dependent on the implementation of Traffic Stats.
- :fifthPercentile: Data points with values less than or equal to this number constitute the "bottom" 5% of the data set
- :max: The maximum value that can be found in the requested data set
- :min: The minimum value that can be found in the requested data set
- :ninetyEighthPercentile: Data points with values greater than or equal to this number constitute the "top" 2% of the data set
- :ninetyFifthPercentile: Data points with values greater than or equal to this number constitute the "top" 5% of the data set
- :totalBytes: When the ``metricType`` requested is ``kbps``, this will contain the total number of *kilobytes* - **not** *bytes* - transferred by the :term:`Delivery Service` within the requested time window. Note that fractional amounts are possible, as the data transfer rate will almost certainly not be cleanly divided by the requested time range.
- :totalTransactions: When the ``metricType`` requested is **not** ``kbps``, this will contain the total number of transactions completed by the :term:`Delivery Service` within the requested time window. Note that fractional amounts are possible, as the transaction rate will almost certainly not be cleanly divided by the requested time range.
-
-:version: A legacy field that seems to have been meant to indicate the API version used. Will always be "1.2"
-
- .. deprecated:: 1.4
- As this has no known purpose, developers are advised it will be removed in the future.
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Encoding: gzip
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: zXJGjcYuu6HxWINVp8HA1gL31J3ukry5wCsTDNxtP/waC6rSD8h10KJ9jEAtRzJ9owOSVPvKaA/2bRu/QeuCpQ==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 22 Jul 2019 17:57:14 GMT
- Transfer-Encoding: chunked
-
- { "response": {
- "series": {
- "columns": [
- "time",
- "sum_count"
- ],
- "count": 2,
- "name": "tps_total.ds.1min",
- "tags": {
- "cachegroup": "total"
- },
- "values": [
- [
- 1563818100000000000,
- 0
- ],
- [
- 1563818160000000000,
- 0
- ]
- ]
- },
- "source": "TrafficStats",
- "summary": {
- "average": 0,
- "count": 2,
- "fifthPercentile": 0,
- "max": 0,
- "min": 0,
- "ninetyEighthPercentile": 0,
- "ninetyFifthPercentile": 0,
- "totalBytes": null,
- "totalTransactions": 0
- },
- "version": "1.2"
- }}
-
-.. [#tenancy] This endpoint respects :term:`Tenancy`, and users whose :term:`Tenant` does not have access to a :term:`Delivery Service` will be unable to view the statistics of said :term:`Delivery Service`.
-.. [#ds-param] Either ``deliveryServiceName`` or ``deliveryService`` *must* be present, but if both are ``deliveryServiceName`` will be used and ``deliveryService`` will be ignored.
diff --git a/docs/source/api/v1/deliveryservice_user.rst b/docs/source/api/v1/deliveryservice_user.rst
deleted file mode 100644
index a299669..0000000
--- a/docs/source/api/v1/deliveryservice_user.rst
+++ /dev/null
@@ -1,88 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-deliveryservice_user:
-
-************************
-``deliveryservice_user``
-************************
-.. deprecated:: ATCv4
-
-``POST``
-========
-Assigns one or more :term:`Delivery Services` to a user.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: Object
-
-Request Structure
------------------
-:userId: An integral, unique identifier for the user to whom the :term:`Delivery Service(s) <Delivery Service>` identified in ``deliveryServices`` will be assigned
-:deliveryServices: An array of integral, unique identifiers for the :term:`Delivery Service(s) <Delivery Service>` being assigned to the user identified by ``userId``
-:replace: An optional field which, when present and ``true`` will replace existing user/ds assignments? (true|false)
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/deliveryservice_user HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 38
- Content-Type: application/json
-
- {"userId": 5, "deliveryServices": [1]}
-
-Response Structure
-------------------
-:userId: The integral, unique identifier of the user to whom the :term:`Delivery Service(s) <Delivery Service>` identified in ``deliveryServices`` are assigned
-:deliveryServices: An array of integral, unique identifiers of :term:`Delivery Services` assigned to the user identified by ``userId``
-:replace: If ``true``, any and all existing, conflicting :term:`Delivery Service` assignments were overwritten by this assignment operation
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 21:37:30 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: Uwl+924m6Ye3NraFP+RBpldkhcNTTDyXHZbzRaYV95p9tP56Z61gckeKSr1oQIkNXjXcCsDN5Dmum7Zk1AR6Hw==
- Content-Length: 127
-
- { "alerts": [
- {
- "level": "success",
- "text": "Delivery service assignments complete."
- },
- {
- "level": "warning",
- "text": "This endpoint and its functionality is deprecated, and will be removed in the future"
- }
- ],
- "response": {
- "userId": 5,
- "deliveryServices": [
- 1
- ]
- }}
diff --git a/docs/source/api/v1/deliveryservice_user_dsid_userid.rst b/docs/source/api/v1/deliveryservice_user_dsid_userid.rst
deleted file mode 100644
index 33f183d..0000000
--- a/docs/source/api/v1/deliveryservice_user_dsid_userid.rst
+++ /dev/null
@@ -1,71 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-deliveryservice_user-dsid-userid:
-
-********************************************
-``deliveryservice_user/{{dsID}}/{{userID}}``
-********************************************
-.. deprecated:: ATCv4
-
-``DELETE``
-==========
-Removes a :term:`Delivery Service` from a user.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
- +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +========+=========================================================================================================================================+
- | dsId | An integral, unique identifier for the :term:`Delivery Service` which should no longer be assigned to the user identified by ``userID`` |
- +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | userId | An integral, unique identifier for the user to whom the :term:`Delivery Service` identified by ``dsID`` should no longer be assigned |
- +--------+-----------------------------------------------------------------------------------------------------------------------------------------+
-
-Response Structure
-------------------
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Content-Type: application/json
- Date: Wed, 14 Nov 2018 21:40:06 GMT
- Server: Mojolicious (Perl)
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Vary: Accept-Encoding
- Whole-Content-Sha512: /eNE3LhFABGukcczjxJOYiwmfVTUUKII9RRuZi14AbF65BLhHdXZ5lAVEi4Hc65+ojNaijBgI9jTmgO4XCcP/A==
- Content-Length: 100
-
- { "alerts": [
- {
- "level": "success",
- "text": "User [ test ] unlinked from deliveryservice [ 1 | demo1 ]."
- },
- {
- "level": "warning",
- "text": "This endpoint and its functionality is deprecated, and will be removed in the future"
- }
- ]}
diff --git a/docs/source/api/v1/deliveryservices.rst b/docs/source/api/v1/deliveryservices.rst
deleted file mode 100644
index 136ee64..0000000
--- a/docs/source/api/v1/deliveryservices.rst
+++ /dev/null
@@ -1,625 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v1-deliveryservices:
-
-********************
-``deliveryservices``
-********************
-
-``GET``
-=======
-Retrieves :term:`Delivery Services`
-
-:Auth. Required: Yes
-:Roles Required: None\ [#tenancy]_
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Query Parameters
-
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=============+==========+======================================================================================================================================+
- | cdn | no | Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Show only the :term:`Delivery Service` that has this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | profile | no | Return only :term:`Delivery Services` using the :term:`Profile` that has this :ref:`profile-id` |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only :term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types` identified by this integral, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | xmlId | no | Show only the :term:`Delivery Service` that has this text-based, unique identifier |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
- | | | array |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | limit | no | Choose the maximum number of results to return |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
- | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
- +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
-
-Response Structure
-------------------
-:active: A boolean that defines :ref:`ds-active`.
-:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
-:cacheurl: A :ref:`ds-cacheurl`
-
- .. deprecated:: ATCv3.0
- This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
-
-:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
-:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:checkPath: A :ref:`ds-check-path`
-:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
-
- .. versionadded:: 1.4
-
-:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
-
- .. versionadded:: 1.4
-
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:displayName: The :ref:`ds-display-name`
-:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
-:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
-:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
-:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
-:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
-:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
-
- .. versionadded:: 1.5
-
-:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
-:exampleURLs: An array of :ref:`ds-example-urls`
-:fqPacingRate: The :ref:`ds-fqpr`
-
- .. versionadded:: 1.3
-
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
-:globalMaxTps: The :ref:`ds-global-max-tps`
-:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
-:id: An integral, unique identifier for this :term:`Delivery Service`
-:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :ref:`non-rfc-datetime`
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The 2nd long description of this :term:`Delivery Service`
-:longDesc2: the 3rd long description of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
- :type: The type of match performed using ``pattern``.
-
-:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
-:maxOriginConnections: The :ref:`ds-max-origin-connections`
-
- .. versionadded:: 1.4
-
-:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
-:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
-:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
-:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
-:orgServerFqdn: The :ref:`ds-origin-url`
-:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
-:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
-:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
-:regexRemap: A :ref:`ds-regex-remap`
-:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
-:remapText: :ref:`ds-raw-remap`
-:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
-:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3.
-
- .. versionadded:: 1.5
-
-:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
-:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:type: The :ref:`ds-types` of this :term:`Delivery Service`
-:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
-:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
-
-.. code-block:: http
- :caption: Response Example
-
- HTTP/1.1 200 OK
- Access-Control-Allow-Credentials: true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Access-Control-Allow-Origin: *
- Content-Type: application/json
- Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512: mCLMjvACRKHNGP/OSx4javkOtxxzyiDdQzsV78IamUhVmvyKyKaCeOKRmpsG69w+nhh3OkPZ6e9MMeJpcJSKcA==
- X-Server-Name: traffic_ops_golang/
- Date: Thu, 15 Nov 2018 19:04:29 GMT
- Transfer-Encoding: chunked
-
- { "response": [{
- "active": true,
- "anonymousBlockingEnabled": false,
- "cacheurl": null,
- "ccrDnsTtl": null,
- "cdnId": 2,
- "cdnName": "CDN-in-a-Box",
- "checkPath": null,
- "displayName": "Demo 1",
- "dnsBypassCname": null,
- "dnsBypassIp": null,
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": 0,
- "edgeHeaderRewrite": null,
- "geoLimit": 0,
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": 0,
- "globalMaxMbps": null,
- "globalMaxTps": null,
- "httpBypassFqdn": null,
- "id": 1,
- "infoUrl": null,
- "initialDispersion": 1,
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2019-05-15 14:32:05+00",
- "logsEnabled": true,
- "longDesc": "Apachecon North America 2018",
- "longDesc1": null,
- "longDesc2": null,
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": 0,
- "pattern": ".*\\.demo1\\..*"
- }
- ],
- "maxDnsAnswers": null,
- "midHeaderRewrite": null,
- "missLat": 42,
- "missLong": -88,
- "multiSiteOrigin": false,
- "originShield": null,
- "orgServerFqdn": "http://origin.infra.ciab.test",
- "profileDescription": null,
- "profileId": null,
- "profileName": null,
- "protocol": 2,
- "qstringIgnore": 0,
- "rangeRequestHandling": 0,
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "routingName": "video",
- "signed": false,
- "sslKeyVersion": null,
- "tenantId": 1,
- "type": "HTTP",
- "typeId": 1,
- "xmlId": "demo1",
- "exampleURLs": [
- "http://video.demo1.mycdn.ciab.test",
- "https://video.demo1.mycdn.ciab.test"
- ],
- "deepCachingType": "NEVER",
- "fqPacingRate": null,
- "signingAlgorithm": null,
- "tenant": "root",
- "trResponseHeaders": null,
- "trRequestHeaders": null,
- "consistentHashRegex": null,
- "consistentHashQueryParams": [
- "abc",
- "pdq",
- "xxx",
- "zyx"
- ],
- "maxOriginConnections": 0,
- "ecsEnabled": false,
- "rangeSliceBlockSize": null
- }]}
-
-
-``POST``
-========
-Allows users to create :term:`Delivery Service`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"\ [#tenancy]_
-:Response Type: Array
-
-Request Structure
------------------
-:active: A boolean that defines :ref:`ds-active`.
-:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
-:cacheurl: A :ref:`ds-cacheurl`
-
- .. deprecated:: ATCv3.0
- This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
-
-:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
-:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:checkPath: A :ref:`ds-check-path`
-:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
-
- .. versionadded:: 1.4
-
-:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
-
- .. versionadded:: 1.4
-
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:displayName: The :ref:`ds-display-name`
-:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
-:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
-:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
-:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
-:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
-:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
-
- .. versionadded:: 1.5
-
-:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
-:fqPacingRate: The :ref:`ds-fqpr`
-
- .. versionadded:: 1.3
-
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`\ [#geolimit]_
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`\ [#geolimit]_
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
-:globalMaxTps: The :ref:`ds-global-max-tps`
-:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
-:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: An optional field containing the 2nd long description of this :term:`Delivery Service`
-:longDesc2: An optional field containing the 3rd long description of this :term:`Delivery Service`
-:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
-:maxOriginConnections: The :ref:`ds-max-origin-connections`
-
- .. versionadded:: 1.4
-
-:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
-:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
-:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
-:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
-:orgServerFqdn: The :ref:`ds-origin-url`
-:originShield: A :ref:`ds-origin-shield` string
-:profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be associated
-:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
-:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
-:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
-:regexRemap: A :ref:`ds-regex-remap`
-:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
-:remapText: :ref:`ds-raw-remap`
-:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
-:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3. It can only be between (inclusive) 262144 (256KB) - 33554432 (32MB).
-
- .. versionadded:: 1.5
-
-:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
-:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:type: The :ref:`ds-types` of this :term:`Delivery Service`
-:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
-:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
-
-.. code-block:: http
- :caption: Request Example
-
- POST /api/1.4/deliveryservices HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
- Content-Length: 761
- Content-Type: application/json
-
- {
- "active": false,
- "anonymousBlockingEnabled": false,
- "cdnId": 2,
- "deepCachingType": "NEVER",
- "displayName": "test",
- "dscp": 0,
- "ecsEnabled": true,
- "geoLimit": 0,
- "geoProvider": 0,
- "initialDispersion": 1,
- "ipv6RoutingEnabled": false,
- "logsEnabled": true,
- "longDesc": "A Delivery Service created expressly for API documentation examples",
- "missLat": 0,
- "missLong": 0,
- "maxOriginConnections": 0,
- "multiSiteOrigin": false,
- "orgServerFqdn": "http://origin.infra.ciab.test",
- "protocol": 0,
- "qstringIgnore": 0,
- "rangeRequestHandling": 0,
- "regionalGeoBlocking": false,
- "routingName": "test",
- "signed": false,
- "tenant": "root",
- "tenantId": 1,
- "typeId": 1,
- "xmlId": "test"
- }
-
-
-Response Structure
-------------------
-:active: A boolean that defines :ref:`ds-active`.
-:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
-:cacheurl: A :ref:`ds-cacheurl`
-
- .. deprecated:: ATCv3.0
- This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
-
-:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
-:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:checkPath: A :ref:`ds-check-path`
-:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
-
- .. versionadded:: 1.4
-
-:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
-
- .. versionadded:: 1.4
-
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
-
- .. versionadded:: 1.3
-
-:displayName: The :ref:`ds-display-name`
-:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
-:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
-:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
-:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
-:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
-:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
-
- .. versionadded:: 1.5
-
-:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
-:exampleURLs: An array of :ref:`ds-example-urls`
-:fqPacingRate: The :ref:`ds-fqpr`
-
- .. versionadded:: 1.3
-
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
... 46550 lines suppressed ...