This is an automated email from the ASF dual-hosted git repository.
ocket8888 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 ced2bb3 Document endpoint perms for role based permissions (#6144)
ced2bb3 is described below
commit ced2bb3626f2d0e814e07507e59b75ecda9c8bfd
Author: Steve Hamrick <[email protected]>
AuthorDate: Fri Oct 15 07:22:38 2021 -0600
Document endpoint perms for role based permissions (#6144)
* Update docs for permissions
* Add missing docs
* Update permissions
* Fix plurality
* Code review changes
* More fixes
* Missed one
* Fixes
* Fix docs
* Fix docs
---
docs/source/api/index.rst | 7 +-
docs/source/api/v4/about.rst | 1 +
docs/source/api/v4/acme_accounts.rst | 3 +
.../source/api/v4/acme_accounts_provider_email.rst | 1 +
docs/source/api/v4/acme_accounts_providers.rst | 1 +
docs/source/api/v4/acme_autorenew.rst | 1 +
docs/source/api/v4/asns.rst | 4 +
docs/source/api/v4/asns_id.rst | 2 +
docs/source/api/v4/async_status.rst | 1 +
docs/source/api/v4/cache_stats.rst | 1 +
docs/source/api/v4/cachegroups.rst | 2 +
docs/source/api/v4/cachegroups_id.rst | 2 +
.../api/v4/cachegroups_id_deliveryservices.rst | 1 +
docs/source/api/v4/cachegroups_id_queue_update.rst | 1 +
docs/source/api/v4/caches_stats.rst | 1 +
docs/source/api/v4/capabilities.rst | 1 +
docs/source/api/v4/cdn_locks.rst | 3 +
docs/source/api/v4/cdn_notifications.rst | 3 +
docs/source/api/v4/cdns.rst | 2 +
docs/source/api/v4/cdns_capacity.rst | 1 +
docs/source/api/v4/cdns_dnsseckeys_generate.rst | 1 +
docs/source/api/v4/cdns_dnsseckeys_refresh.rst | 1 +
docs/source/api/v4/cdns_domains.rst | 1 +
docs/source/api/v4/cdns_health.rst | 1 +
docs/source/api/v4/cdns_id.rst | 2 +
docs/source/api/v4/cdns_id_queue_update.rst | 1 +
.../source/api/v4/cdns_name_configs_monitoring.rst | 1 +
.../api/v4/cdns_name_dnsseckeys_ksk_generate.rst | 1 +
docs/source/api/v4/cdns_name_federations.rst | 2 +
docs/source/api/v4/cdns_name_federations_id.rst | 2 +
docs/source/api/v4/cdns_name_health.rst | 1 +
docs/source/api/v4/cdns_name_name.rst | 1 +
docs/source/api/v4/cdns_name_name_dnsseckeys.rst | 2 +
docs/source/api/v4/cdns_name_name_sslkeys.rst | 1 +
docs/source/api/v4/cdns_name_snapshot.rst | 1 +
docs/source/api/v4/cdns_name_snapshot_new.rst | 1 +
docs/source/api/v4/cdns_routing.rst | 1 +
docs/source/api/v4/consistenthash.rst | 1 +
docs/source/api/v4/coordinates.rst | 4 +
docs/source/api/v4/current_stats.rst | 1 +
docs/source/api/v4/dbdump.rst | 1 +
.../api/v4/deliveryservice_request_comments.rst | 4 +
docs/source/api/v4/deliveryservice_requests.rst | 4 +
.../api/v4/deliveryservice_requests_id_assign.rst | 2 +
.../api/v4/deliveryservice_requests_id_status.rst | 2 +
docs/source/api/v4/deliveryservice_stats.rst | 1 +
docs/source/api/v4/deliveryservices.rst | 2 +
.../v4/deliveryservices_dnsseckeys_generate.rst | 1 +
docs/source/api/v4/deliveryservices_id.rst | 2 +
.../source/api/v4/deliveryservices_id_capacity.rst | 1 +
docs/source/api/v4/deliveryservices_id_health.rst | 1 +
docs/source/api/v4/deliveryservices_id_regexes.rst | 2 +
.../api/v4/deliveryservices_id_regexes_rid.rst | 2 +
docs/source/api/v4/deliveryservices_id_routing.rst | 1 +
docs/source/api/v4/deliveryservices_id_safe.rst | 1 +
..._metric_types_start_date_start_end_date_end.rst | 128 ------------------
docs/source/api/v4/deliveryservices_id_servers.rst | 1 +
.../v4/deliveryservices_id_servers_eligible.rst | 1 +
docs/source/api/v4/deliveryservices_id_urlkeys.rst | 2 +
docs/source/api/v4/deliveryservices_regexes.rst | 1 +
.../v4/deliveryservices_required_capabilities.rst | 3 +
.../source/api/v4/deliveryservices_sslkeys_add.rst | 1 +
.../api/v4/deliveryservices_sslkeys_generate.rst | 1 +
.../v4/deliveryservices_sslkeys_generate_acme.rst | 1 +
...liveryservices_sslkeys_generate_letsencrypt.rst | 1 +
.../api/v4/deliveryservices_xmlid_servers.rst | 1 +
.../api/v4/deliveryservices_xmlid_urisignkeys.rst | 4 +
.../v4/deliveryservices_xmlid_xmlid_sslkeys.rst | 2 +
.../v4/deliveryservices_xmlid_xmlid_urlkeys.rst | 2 +
...d_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst | 1 +
...liveryservices_xmlid_xmlid_urlkeys_generate.rst | 1 +
docs/source/api/v4/deliveryserviceserver.rst | 2 +
.../api/v4/deliveryserviceserver_dsid_serverid.rst | 1 +
docs/source/api/v4/divisions.rst | 2 +
docs/source/api/v4/divisions_id.rst | 62 +++++++++
docs/source/api/v4/federation_resolvers.rst | 3 +
docs/source/api/v4/federations.rst | 6 +-
docs/source/api/v4/federations_all.rst | 1 +
.../api/v4/federations_id_deliveryservices.rst | 2 +
.../api/v4/federations_id_deliveryservices_id.rst | 1 +
.../api/v4/federations_id_federation_resolvers.rst | 2 +
docs/source/api/v4/federations_id_users.rst | 2 +
docs/source/api/v4/federations_id_users_id.rst | 1 +
docs/source/api/v4/isos.rst | 1 +
docs/source/api/v4/jobs.rst | 4 +
docs/source/api/v4/letsencrypt_autorenew.rst | 1 +
docs/source/api/v4/letsencrypt_dnsrecords.rst | 1 +
docs/source/api/v4/logs.rst | 1 +
docs/source/api/v4/logs_newcount.rst | 1 +
docs/source/api/v4/origins.rst | 4 +
docs/source/api/v4/osversions.rst | 1 +
docs/source/api/v4/parameterprofile.rst | 1 +
docs/source/api/v4/parameters.rst | 2 +
docs/source/api/v4/parameters_id.rst | 2 +
docs/source/api/v4/phys_locations.rst | 2 +
docs/source/api/v4/phys_locations_id.rst | 2 +
docs/source/api/v4/plugins.rst | 1 +
docs/source/api/v4/profileparameter.rst | 1 +
docs/source/api/v4/profileparameters.rst | 4 +-
.../v4/profileparameters_profileID_parameterID.rst | 1 +
docs/source/api/v4/profiles.rst | 2 +
docs/source/api/v4/profiles_id.rst | 2 +
docs/source/api/v4/profiles_id_export.rst | 1 +
docs/source/api/v4/profiles_id_parameters.rst | 2 +
docs/source/api/v4/profiles_import.rst | 1 +
.../source/api/v4/profiles_name_name_copy_copy.rst | 1 +
.../api/v4/profiles_name_name_parameters.rst | 2 +
docs/source/api/v4/regions.rst | 3 +
docs/source/api/v4/regions_id.rst | 1 +
docs/source/api/v4/roles.rst | 4 +
docs/source/api/v4/server_capabilities.rst | 4 +
docs/source/api/v4/server_server_capabilities.rst | 3 +
docs/source/api/v4/servercheck.rst | 2 +
docs/source/api/v4/servercheck_extensions.rst | 2 +
docs/source/api/v4/servercheck_extensions_id.rst | 1 +
docs/source/api/v4/servers.rst | 2 +
docs/source/api/v4/servers_details.rst | 1 +
docs/source/api/v4/servers_hostname_update.rst | 1 +
.../api/v4/servers_hostname_update_status.rst | 1 +
docs/source/api/v4/servers_id.rst | 2 +
docs/source/api/v4/servers_id_deliveryservices.rst | 2 +
docs/source/api/v4/servers_id_queue_update.rst | 1 +
docs/source/api/v4/servers_id_status.rst | 1 +
...ervicecategories.rst => service_categories.rst} | 53 +-------
docs/source/api/v4/service_categories_name.rst | 149 +++++++++++++++++++++
docs/source/api/v4/snapshot.rst | 1 +
docs/source/api/v4/staticdnsentries.rst | 3 +
docs/source/api/v4/stats_summary.rst | 2 +
docs/source/api/v4/statuses.rst | 62 +++++++++
.../api/v4/{statuses.rst => statuses_id.rst} | 72 +++++++++-
docs/source/api/v4/steering.rst | 1 +
docs/source/api/v4/steering_id_targets.rst | 2 +
.../source/api/v4/steering_id_targets_targetID.rst | 2 +
docs/source/api/v4/system_info.rst | 1 +
docs/source/api/v4/tenants.rst | 2 +
docs/source/api/v4/tenants_id.rst | 2 +
docs/source/api/v4/topologies.rst | 3 +
.../source/api/v4/topologies_name_queue_update.rst | 1 +
docs/source/api/v4/types.rst | 2 +
docs/source/api/v4/types_id.rst | 2 +
docs/source/api/v4/user_current.rst | 2 +
docs/source/api/v4/user_login.rst | 1 +
docs/source/api/v4/user_login_oauth.rst | 1 +
docs/source/api/v4/user_login_token.rst | 1 +
docs/source/api/v4/user_logout.rst | 1 +
docs/source/api/v4/user_reset_password.rst | 1 +
docs/source/api/v4/users.rst | 2 +
docs/source/api/v4/users_id.rst | 2 +
docs/source/api/v4/users_register.rst | 1 +
docs/source/api/v4/vault_ping.rst | 1 +
150 files changed, 587 insertions(+), 187 deletions(-)
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
index 58f7166..967aee2 100644
--- a/docs/source/api/index.rst
+++ b/docs/source/api/index.rst
@@ -29,7 +29,12 @@ Every endpoint is documented with a section for each method,
containing the subs
Auth. Required
This will either be 'Yes' to indicate that a user must be authenticated
(or "logged-in") via e.g. :ref:`to-api-user-login` to use this method of the
endpoint, or 'No' to indicate that this is not required.
Roles Required
- Any permissions roles that are allowed to use this method of the
endpoint will be listed here. Users with roles not listed here will be unable
to properly use these endpoints
+ .. deprecated:: ATCv7.0
+ Roles for the use of authentication/permissions have been
deprecated in favor of role based permissions, see :pr:`5848`.
+
+ Any permissions roles that are allowed to use this method of the
endpoint will be listed here. Users with roles not listed here will be unable
to properly use these endpoints.
+Permissions Required
+ Any permissions that are needed to use this endpoint. Users with roles
that don't have the permissions will be unable to properly use these endpoints.
Response Type
Unless otherwise noted, all responses are JSON objects. See `Response
Structure`_ for more information.
diff --git a/docs/source/api/v4/about.rst b/docs/source/api/v4/about.rst
index a713cc7..f0e5683 100644
--- a/docs/source/api/v4/about.rst
+++ b/docs/source/api/v4/about.rst
@@ -26,6 +26,7 @@ Returns info about the Traffic Ops build that is currently
running, generated at
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: None
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/acme_accounts.rst
b/docs/source/api/v4/acme_accounts.rst
index f8a26ee..8616a85 100644
--- a/docs/source/api/v4/acme_accounts.rst
+++ b/docs/source/api/v4/acme_accounts.rst
@@ -27,6 +27,7 @@ Gets information for all :term:`ACME Account` s.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ACME:READ
:Response Type: Array
Request Structure
@@ -63,6 +64,7 @@ Creates a new :term:`ACME Account`.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ACME:CREATE, ACME:READ
:Response Type: Object
Request Structure
@@ -134,6 +136,7 @@ Updates an existing :term:`ACME Account`.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ACME:UPDATE, ACME:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/acme_accounts_provider_email.rst
b/docs/source/api/v4/acme_accounts_provider_email.rst
index d9df57f..4dd7777 100644
--- a/docs/source/api/v4/acme_accounts_provider_email.rst
+++ b/docs/source/api/v4/acme_accounts_provider_email.rst
@@ -27,6 +27,7 @@ Delete :term:`ACME Account` information.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ACME:DELETE, ACME:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/acme_accounts_providers.rst
b/docs/source/api/v4/acme_accounts_providers.rst
index aa339fd..8dfc1c3 100644
--- a/docs/source/api/v4/acme_accounts_providers.rst
+++ b/docs/source/api/v4/acme_accounts_providers.rst
@@ -27,6 +27,7 @@ Gets a list of all :abbr:`ACME (Automatic Certificate
Management Environment)` p
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ACME:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/acme_autorenew.rst
b/docs/source/api/v4/acme_autorenew.rst
index 249b803..0ac7171 100644
--- a/docs/source/api/v4/acme_autorenew.rst
+++ b/docs/source/api/v4/acme_autorenew.rst
@@ -25,6 +25,7 @@ Generates SSL certificates and private keys for all
:term:`Delivery Services` th
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ACME:READ, DS-SECURITY-KEY:UPDATE,
DELIVERY-SERVICE:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/asns.rst b/docs/source/api/v4/asns.rst
index 78d7daf..cdb37e0 100644
--- a/docs/source/api/v4/asns.rst
+++ b/docs/source/api/v4/asns.rst
@@ -27,6 +27,7 @@ List all :abbr:`ASNs (Autonomous System Numbers)`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: ASN:READ, CACHE-GROUP:READ
:Response Type: Array
Request Structure
@@ -111,6 +112,7 @@ Creates a new :abbr:`ASN (Autonomous System Number)`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASN:CREATE, ASN:READ, CACHE-GROUP:READ,
CACHE-GROUP:UPDATE
:Response Type: Object
Request Structure
@@ -180,6 +182,7 @@ Updates an existing :abbr:`ASN (Autonomous System Number)`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASN:UPDATE, ASN:READ, CACHE-GROUP:READ,
CACHE-GROUP:UPDATE
:Response Type: Object
Request Structure
@@ -251,6 +254,7 @@ Deletes an existing :abbr:`ASN (Autonomous System Number)`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASN:DELETE, ASN:READ, CACHE-GROUP:READ,
CACHE-GROUP:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/asns_id.rst b/docs/source/api/v4/asns_id.rst
index 14146ca..72cb4b1 100644
--- a/docs/source/api/v4/asns_id.rst
+++ b/docs/source/api/v4/asns_id.rst
@@ -27,6 +27,7 @@ Allows user to edit an existing :abbr:`ASN (Autonomous System
Number)`-to-:term:
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASN:UPDATE, ASN:READ, CACHE-GROUP:UPDATE,
CACHE-GROUP:READ
:Response Type: Object
Request Structure
@@ -104,6 +105,7 @@ Deletes an association between an :abbr:`ASN (Autonomous
System Number)` and a :
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASN:DELETE, ASN:READ, CACHE-GROUP:READ,
CACHE-GROUP:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/async_status.rst
b/docs/source/api/v4/async_status.rst
index 6744cff..6f1a1e9 100644
--- a/docs/source/api/v4/async_status.rst
+++ b/docs/source/api/v4/async_status.rst
@@ -25,6 +25,7 @@ Returns a status update for an asynchronous task.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ASYNC-STATUS:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cache_stats.rst
b/docs/source/api/v4/cache_stats.rst
index 3f0c1aa..297205b 100644
--- a/docs/source/api/v4/cache_stats.rst
+++ b/docs/source/api/v4/cache_stats.rst
@@ -29,6 +29,7 @@ Retrieves statistics about the caches within the CDN
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cachegroups.rst
b/docs/source/api/v4/cachegroups.rst
index eb63e40..561776d 100644
--- a/docs/source/api/v4/cachegroups.rst
+++ b/docs/source/api/v4/cachegroups.rst
@@ -25,6 +25,7 @@ Extract information about :term:`Cache Groups`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CACHE-GROUP:READ, TYPE:READ
:Response Type: Array
Request Structure
@@ -127,6 +128,7 @@ Creates a :term:`Cache Group`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CACHE-GROUP:CREATE, CACHE-GROUP:READ, TYPE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cachegroups_id.rst
b/docs/source/api/v4/cachegroups_id.rst
index 0491425..284e347 100644
--- a/docs/source/api/v4/cachegroups_id.rst
+++ b/docs/source/api/v4/cachegroups_id.rst
@@ -25,6 +25,7 @@ Update :term:`Cache Group`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CACHE-GROUP:UPDATE, CACHE-GROUP:READ, TYPE:READ
:Response Type: Object
Request Structure
@@ -144,6 +145,7 @@ Delete a :term:`Cache Group`. A :term:`Cache Group` which
has assigned servers o
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CACHE-GROUP:DELETE, CACHE-GROUP:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/cachegroups_id_deliveryservices.rst
b/docs/source/api/v4/cachegroups_id_deliveryservices.rst
index 16cb8f2..d014e9c 100644
--- a/docs/source/api/v4/cachegroups_id_deliveryservices.rst
+++ b/docs/source/api/v4/cachegroups_id_deliveryservices.rst
@@ -27,6 +27,7 @@ Assigns all of the "assignable" servers within a :term:`Cache
Group` to one or m
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CACHE-GROUP:UPDATE, DELIVERY-SERVICE:UPDATE,
CACHE-GROUP:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cachegroups_id_queue_update.rst
b/docs/source/api/v4/cachegroups_id_queue_update.rst
index d745104..ced0e56 100644
--- a/docs/source/api/v4/cachegroups_id_queue_update.rst
+++ b/docs/source/api/v4/cachegroups_id_queue_update.rst
@@ -25,6 +25,7 @@
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CACHE-GROUP:READ, CDN:READ, SERVER:READ, SERVER:QUEUE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/caches_stats.rst
b/docs/source/api/v4/caches_stats.rst
index d97c926..9b2238c 100644
--- a/docs/source/api/v4/caches_stats.rst
+++ b/docs/source/api/v4/caches_stats.rst
@@ -29,6 +29,7 @@ Retrieves cache stats from Traffic Monitor. Also includes
rows for aggregates.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CACHE-GROUP:READ, PROFILE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/capabilities.rst
b/docs/source/api/v4/capabilities.rst
index 7fc86be..f93b808 100644
--- a/docs/source/api/v4/capabilities.rst
+++ b/docs/source/api/v4/capabilities.rst
@@ -25,6 +25,7 @@ Get all capabilities.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CAPABILITY:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/cdn_locks.rst b/docs/source/api/v4/cdn_locks.rst
index 198c562..85151d0 100644
--- a/docs/source/api/v4/cdn_locks.rst
+++ b/docs/source/api/v4/cdn_locks.rst
@@ -27,6 +27,7 @@ Gets information for all CDN locks.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Array
Request Structure
@@ -71,6 +72,7 @@ Allows user to acquire a lock on a CDN.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN-LOCK:CREATE, CDN:READ
:Response Type: Object
Request Structure
@@ -140,6 +142,7 @@ Deletes an existing ``CDN Lock``.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN-LOCK:DELETE, CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdn_notifications.rst
b/docs/source/api/v4/cdn_notifications.rst
index 16ff2c7..c056192 100644
--- a/docs/source/api/v4/cdn_notifications.rst
+++ b/docs/source/api/v4/cdn_notifications.rst
@@ -26,6 +26,7 @@ List CDN notifications.
:Auth. Required: Yes
:Roles Required: Read-Only
+:Permissions Required: CDN:READ
:Response Type: Array
Request Structure
@@ -94,6 +95,7 @@ Creates a notification for a specific CDN.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:UPDATE
:Response Type: Object
Request Structure
@@ -163,6 +165,7 @@ Deletes an existing CDN notification.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/cdns.rst b/docs/source/api/v4/cdns.rst
index ecbc5c1..219625e 100644
--- a/docs/source/api/v4/cdns.rst
+++ b/docs/source/api/v4/cdns.rst
@@ -24,6 +24,7 @@ Extract information about all CDNs
=======
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Array
Request Structure
@@ -106,6 +107,7 @@ Allows user to create a CDN
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:CREATE, CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_capacity.rst
b/docs/source/api/v4/cdns_capacity.rst
index 9a2392d..70560fa 100644
--- a/docs/source/api/v4/cdns_capacity.rst
+++ b/docs/source/api/v4/cdns_capacity.rst
@@ -25,6 +25,7 @@ Retrieves the aggregate capacity percentages of all
:term:`Cache Groups` for a g
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_dnsseckeys_generate.rst
b/docs/source/api/v4/cdns_dnsseckeys_generate.rst
index 0255951..243a75f 100644
--- a/docs/source/api/v4/cdns_dnsseckeys_generate.rst
+++ b/docs/source/api/v4/cdns_dnsseckeys_generate.rst
@@ -25,6 +25,7 @@ Generates :abbr:`ZSK (Zone-Signing Key)` and :abbr:`KSK
(Key-Signing Key)` keypa
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DNS-SEC:CREATE, CDN:UPDATE, CDN:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/cdns_dnsseckeys_refresh.rst
b/docs/source/api/v4/cdns_dnsseckeys_refresh.rst
index 512e2ee..314e750 100644
--- a/docs/source/api/v4/cdns_dnsseckeys_refresh.rst
+++ b/docs/source/api/v4/cdns_dnsseckeys_refresh.rst
@@ -25,6 +25,7 @@ Refresh the DNSSEC keys for all CDNs. This call initiates a
background process t
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DNS-SEC:UPDATE, CDN:UPDATE, CDN:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/cdns_domains.rst
b/docs/source/api/v4/cdns_domains.rst
index 7af0dac..4211a1c 100644
--- a/docs/source/api/v4/cdns_domains.rst
+++ b/docs/source/api/v4/cdns_domains.rst
@@ -25,6 +25,7 @@ Gets a list of domains and their related Traffic Router
:term:`Profiles` for all
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ, PROFILE:READ, PARAMETER:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/cdns_health.rst
b/docs/source/api/v4/cdns_health.rst
index af4c14a..fde114c 100644
--- a/docs/source/api/v4/cdns_health.rst
+++ b/docs/source/api/v4/cdns_health.rst
@@ -26,6 +26,7 @@ Extract health information from all :term:`Cache Groups`
across all CDNs
=======
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CACHE-GROUP:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_id.rst b/docs/source/api/v4/cdns_id.rst
index 33d0763..90d1e20 100644
--- a/docs/source/api/v4/cdns_id.rst
+++ b/docs/source/api/v4/cdns_id.rst
@@ -25,6 +25,7 @@ Allows a user to edit a specific CDN
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:UPDATE, CDN:READ
:Response Type: Object
Request Structure
@@ -97,6 +98,7 @@ Allows a user to delete a specific CDN
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:DELETE, CDN:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/cdns_id_queue_update.rst
b/docs/source/api/v4/cdns_id_queue_update.rst
index 63f0548..3f179e6 100644
--- a/docs/source/api/v4/cdns_id_queue_update.rst
+++ b/docs/source/api/v4/cdns_id_queue_update.rst
@@ -25,6 +25,7 @@
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:QUEUE, CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_name_configs_monitoring.rst
b/docs/source/api/v4/cdns_name_configs_monitoring.rst
index 318149e..6a45f05 100644
--- a/docs/source/api/v4/cdns_name_configs_monitoring.rst
+++ b/docs/source/api/v4/cdns_name_configs_monitoring.rst
@@ -27,6 +27,7 @@ Retrieves information concerning the monitoring configuration
for a specific CDN
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: MONITOR-CONFIG:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_name_dnsseckeys_ksk_generate.rst
b/docs/source/api/v4/cdns_name_dnsseckeys_ksk_generate.rst
index 29f2ef1..79fdd9b 100644
--- a/docs/source/api/v4/cdns_name_dnsseckeys_ksk_generate.rst
+++ b/docs/source/api/v4/cdns_name_dnsseckeys_ksk_generate.rst
@@ -25,6 +25,7 @@ Generates a new :abbr:`KSK (Key-Signing Key)` for a specific
CDN.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DNS-SEC:CREATE, CDN:UPDATE, CDN:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/cdns_name_federations.rst
b/docs/source/api/v4/cdns_name_federations.rst
index 97a1271..2f391c2 100644
--- a/docs/source/api/v4/cdns_name_federations.rst
+++ b/docs/source/api/v4/cdns_name_federations.rst
@@ -25,6 +25,7 @@ Retrieves a list of federations in use by a specific CDN.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ, FEDERATION:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -117,6 +118,7 @@ Creates a new federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:CREATE, FEDERATION:READ, CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_name_federations_id.rst
b/docs/source/api/v4/cdns_name_federations_id.rst
index ceaef6f..4b934f2 100644
--- a/docs/source/api/v4/cdns_name_federations_id.rst
+++ b/docs/source/api/v4/cdns_name_federations_id.rst
@@ -25,6 +25,7 @@ Updates a federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, FEDERATION:READ, CDN:READ
:Response Type: Object
Request Structure
@@ -110,6 +111,7 @@ Deletes a specific federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:DELETE, FEDERATION:READ, CDN:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/cdns_name_health.rst
b/docs/source/api/v4/cdns_name_health.rst
index 5910906..bcf3e6c 100644
--- a/docs/source/api/v4/cdns_name_health.rst
+++ b/docs/source/api/v4/cdns_name_health.rst
@@ -25,6 +25,7 @@ Retrieves the health of all :term:`Cache Groups` for a given
CDN.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ, CACHE-GROUP:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_name_name.rst
b/docs/source/api/v4/cdns_name_name.rst
index 4cfe72d..0cd153d 100644
--- a/docs/source/api/v4/cdns_name_name.rst
+++ b/docs/source/api/v4/cdns_name_name.rst
@@ -25,6 +25,7 @@ Allows a user to delete a CDN by name
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN:DELETE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/cdns_name_name_dnsseckeys.rst
b/docs/source/api/v4/cdns_name_name_dnsseckeys.rst
index fbceaf0..bfa4679 100644
--- a/docs/source/api/v4/cdns_name_name_dnsseckeys.rst
+++ b/docs/source/api/v4/cdns_name_name_dnsseckeys.rst
@@ -25,6 +25,7 @@ Gets a list of DNSSEC keys for CDN and all associated
:term:`Delivery Services`.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DNS-SEC:READ, CDN:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -117,6 +118,7 @@ Delete DNSSEC keys for a CDN and all associated
:term:`Delivery Services`.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DNS-SEC:DELETE, CDN:UPDATE, DELIVERY-SERVICE:UPDATE,
CDN:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/cdns_name_name_sslkeys.rst
b/docs/source/api/v4/cdns_name_name_sslkeys.rst
index 1512597..4418ed5 100644
--- a/docs/source/api/v4/cdns_name_name_sslkeys.rst
+++ b/docs/source/api/v4/cdns_name_name_sslkeys.rst
@@ -25,6 +25,7 @@ Returns SSL certificates for all :term:`Delivery Services`
that are a part of th
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DS-SECURITY-KEY:READ, CDN:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/cdns_name_snapshot.rst
b/docs/source/api/v4/cdns_name_snapshot.rst
index 7d1aee6..f658106 100644
--- a/docs/source/api/v4/cdns_name_snapshot.rst
+++ b/docs/source/api/v4/cdns_name_snapshot.rst
@@ -26,6 +26,7 @@ Retrieves the *current* :term:`Snapshot` for a CDN, which
represents the current
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN-SNAPSHOT:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_name_snapshot_new.rst
b/docs/source/api/v4/cdns_name_snapshot_new.rst
index f71dcd1..d6fc6e3 100644
--- a/docs/source/api/v4/cdns_name_snapshot_new.rst
+++ b/docs/source/api/v4/cdns_name_snapshot_new.rst
@@ -25,6 +25,7 @@ Retrieves the *pending* :term:`Snapshot` for a CDN, which
represents the current
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN-SNAPSHOT:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/cdns_routing.rst
b/docs/source/api/v4/cdns_routing.rst
index 63e80e1..1d00ff9 100644
--- a/docs/source/api/v4/cdns_routing.rst
+++ b/docs/source/api/v4/cdns_routing.rst
@@ -25,6 +25,7 @@ Retrieves the aggregated routing percentages across all CDNs.
This is accomplish
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/consistenthash.rst
b/docs/source/api/v4/consistenthash.rst
index 9729d64..3bd31cc 100644
--- a/docs/source/api/v4/consistenthash.rst
+++ b/docs/source/api/v4/consistenthash.rst
@@ -26,6 +26,7 @@ Queries database for an active Traffic Router on a given CDN
and sends GET reque
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/coordinates.rst
b/docs/source/api/v4/coordinates.rst
index cd3fab3..6cda66f 100644
--- a/docs/source/api/v4/coordinates.rst
+++ b/docs/source/api/v4/coordinates.rst
@@ -25,6 +25,7 @@ Gets a list of all coordinates in the Traffic Ops database
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: COORDINATE:READ
:Response Type: Array
Request Structure
@@ -133,6 +134,7 @@ Creates a new coordinate pair
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: COORDINATE:CREATE, COORDINATE:READ
:Response Type: Object
Request Structure
@@ -198,6 +200,7 @@ Updates a coordinate
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: COORDINATE:UPDATE, COORDINATE:READ
:Response Type: Object
Request Structure
@@ -270,6 +273,7 @@ Deletes a coordinate
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: COORDINATE:DELETE, COORDINATE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/current_stats.rst
b/docs/source/api/v4/current_stats.rst
index 8824d30..467775c 100644
--- a/docs/source/api/v4/current_stats.rst
+++ b/docs/source/api/v4/current_stats.rst
@@ -27,6 +27,7 @@ Retrieves current stats for each CDN. Also includes aggregate
stats across them.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CDN:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/dbdump.rst b/docs/source/api/v4/dbdump.rst
index 364ca65..e622cab 100644
--- a/docs/source/api/v4/dbdump.rst
+++ b/docs/source/api/v4/dbdump.rst
@@ -30,6 +30,7 @@ Fetches the database dump.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DBDUMP:READ
:Response Type: ``undefined`` - outputs an SQL script, not JSON
Request Structure
diff --git a/docs/source/api/v4/deliveryservice_request_comments.rst
b/docs/source/api/v4/deliveryservice_request_comments.rst
index 80ac356..49d67a8 100644
--- a/docs/source/api/v4/deliveryservice_request_comments.rst
+++ b/docs/source/api/v4/deliveryservice_request_comments.rst
@@ -25,6 +25,7 @@ Gets delivery service request comments.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DS-REQUEST:READ, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Array
Request Structure
@@ -109,6 +110,7 @@ Allows user to create a :term:`Delivery Service Request`
comment.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:UPDATE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Object
Request Structure
@@ -183,6 +185,7 @@ Updates a delivery service request comment.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:UPDATE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Object
@@ -267,6 +270,7 @@ Deletes a delivery service request comment.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:UPDATE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/deliveryservice_requests.rst
b/docs/source/api/v4/deliveryservice_requests.rst
index ce89718..bb9ca7a 100644
--- a/docs/source/api/v4/deliveryservice_requests.rst
+++ b/docs/source/api/v4/deliveryservice_requests.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Delivery Service Requests`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DS-REQUEST:READ, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Array
Request Structure
@@ -201,6 +202,7 @@ Creates a new :term:`Delivery Service Request`. "Closed"
:term:`Delivery Service
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:CREATE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Object
Request Structure
@@ -526,6 +528,7 @@ Updates an existing :term:`Delivery Service Request`. Note
that "closed" :term:`
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:UPDATE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Object
Request Structure
@@ -774,6 +777,7 @@ Deletes a :term:`Delivery Service Request`.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:DELETE, DELIVERY-SERVICE:READ, USER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservice_requests_id_assign.rst
b/docs/source/api/v4/deliveryservice_requests_id_assign.rst
index 8c7acce..a8e14b2 100644
--- a/docs/source/api/v4/deliveryservice_requests_id_assign.rst
+++ b/docs/source/api/v4/deliveryservice_requests_id_assign.rst
@@ -26,6 +26,7 @@ Assign a :term:`Delivery Service Request` to a user.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-REQUEST:READ, USER:READ
:Response Type: Object (string)
Request Structure
@@ -75,6 +76,7 @@ The response is the username of the user to whom the
:term:`Delivery Service Req
=======
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-REQUEST:UPDATE, DS-REQUEST:READ, USER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservice_requests_id_status.rst
b/docs/source/api/v4/deliveryservice_requests_id_status.rst
index 1ecd5f4..a61b58a 100644
--- a/docs/source/api/v4/deliveryservice_requests_id_status.rst
+++ b/docs/source/api/v4/deliveryservice_requests_id_status.rst
@@ -28,6 +28,7 @@ Gets the status of a :term:`DSR`.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:READ
:Response Type: Object (string)
Request Structure
@@ -78,6 +79,7 @@ The response is the status of the requested :term:`DSR`.
=======
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: DS-REQUEST:UPDATE, DS-REQUEST:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservice_stats.rst
b/docs/source/api/v4/deliveryservice_stats.rst
index 61c50f0..895d02e 100644
--- a/docs/source/api/v4/deliveryservice_stats.rst
+++ b/docs/source/api/v4/deliveryservice_stats.rst
@@ -25,6 +25,7 @@ Retrieves time-aggregated statistics on a specific
:term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: STAT:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices.rst
b/docs/source/api/v4/deliveryservices.rst
index dbfc42c..c4bdaeb 100644
--- a/docs/source/api/v4/deliveryservices.rst
+++ b/docs/source/api/v4/deliveryservices.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Delivery Services`
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ, CDN:READ, TYPE:READ
:Response Type: Array
Request Structure
@@ -271,6 +272,7 @@ Allows users to create :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:CREATE, DELIVERY-SERVICE:READ,
CDN:READ, TYPE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_dnsseckeys_generate.rst
b/docs/source/api/v4/deliveryservices_dnsseckeys_generate.rst
index 9cc944b..1b84904 100644
--- a/docs/source/api/v4/deliveryservices_dnsseckeys_generate.rst
+++ b/docs/source/api/v4/deliveryservices_dnsseckeys_generate.rst
@@ -25,6 +25,7 @@ Generates :abbr:`ZSK (Zone-Signing Key)` and :abbr:`KSK
(Key-Signing Key)` keypa
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:UPDATE,
DELIVERY-SERVICE:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id.rst
b/docs/source/api/v4/deliveryservices_id.rst
index 66b3960..8223317 100644
--- a/docs/source/api/v4/deliveryservices_id.rst
+++ b/docs/source/api/v4/deliveryservices_id.rst
@@ -25,6 +25,7 @@ Allows users to edit an existing :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:UPDATE, DELIVERY-SERVICE:READ,
CDN:READ, TYPE:READ
:Response Type: Array (should always have a length of exactly one on success)
Request Structure
@@ -373,6 +374,7 @@ Deletes the target :term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:DELETE, DELIVERY-SERVICE:READ,
CDN:READ, TYPE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_capacity.rst
b/docs/source/api/v4/deliveryservices_id_capacity.rst
index 48bad2e..90f8611 100644
--- a/docs/source/api/v4/deliveryservices_id_capacity.rst
+++ b/docs/source/api/v4/deliveryservices_id_capacity.rst
@@ -27,6 +27,7 @@ Retrieves the usage percentages of a servers associated with
a :term:`Delivery S
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_health.rst
b/docs/source/api/v4/deliveryservices_id_health.rst
index 1c80519..7ff5119 100644
--- a/docs/source/api/v4/deliveryservices_id_health.rst
+++ b/docs/source/api/v4/deliveryservices_id_health.rst
@@ -27,6 +27,7 @@ Retrieves the health of all :term:`Cache Groups` assigned to
a particular :term:
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ, CACHE-GROUP:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_regexes.rst
b/docs/source/api/v4/deliveryservices_id_regexes.rst
index 9e73db8..4c7d3ad 100644
--- a/docs/source/api/v4/deliveryservices_id_regexes.rst
+++ b/docs/source/api/v4/deliveryservices_id_regexes.rst
@@ -25,6 +25,7 @@ Retrieves routing regular expressions for a specific
:term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ, TYPE:READ
:Response Type: Array
Request Structure
@@ -101,6 +102,7 @@ Creates a routing regular expression for a :term:`Delivery
Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:UPDATE, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_regexes_rid.rst
b/docs/source/api/v4/deliveryservices_id_regexes_rid.rst
index 6b5c8ed..781a20d 100644
--- a/docs/source/api/v4/deliveryservices_id_regexes_rid.rst
+++ b/docs/source/api/v4/deliveryservices_id_regexes_rid.rst
@@ -25,6 +25,7 @@ Updates a routing regular expression.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:UPDATE, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: Object
Request Structure
@@ -108,6 +109,7 @@ Deletes a routing regular expression.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:UPDATE, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_routing.rst
b/docs/source/api/v4/deliveryservices_id_routing.rst
index 39aa42e..0d92b7b 100644
--- a/docs/source/api/v4/deliveryservices_id_routing.rst
+++ b/docs/source/api/v4/deliveryservices_id_routing.rst
@@ -25,6 +25,7 @@ Retrieves the aggregated routing percentages for a given
:term:`Delivery Service
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ
:Response Type: Object
.. note:: Only HTTP or DNS :term:`Delivery Services` can be requested.
diff --git a/docs/source/api/v4/deliveryservices_id_safe.rst
b/docs/source/api/v4/deliveryservices_id_safe.rst
index bf7c8dc..0501499 100644
--- a/docs/source/api/v4/deliveryservices_id_safe.rst
+++ b/docs/source/api/v4/deliveryservices_id_safe.rst
@@ -25,6 +25,7 @@ Allows a user to edit metadata fields of a :term:`Delivery
Service`.
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE-SAFE:UPDATE, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: Array
Request Structure
diff --git
a/docs/source/api/v4/deliveryservices_id_server_types_type_metric_types_start_date_start_end_date_end.rst
b/docs/source/api/v4/deliveryservices_id_server_types_type_metric_types_start_date_start_end_date_end.rst
deleted file mode 100644
index 2ce22bd..0000000
---
a/docs/source/api/v4/deliveryservices_id_server_types_type_metric_types_start_date_start_end_date_end.rst
+++ /dev/null
@@ -1,128 +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-deliveryservices-id-server_types-type-metric_types-start_date-start-end_date-end:
-
-****************************************************************************************************
-``deliveryservices/{{id}}/server_types/{{type}}/metric_types/start_date/{{start}}/end_date/{{end}}``
-****************************************************************************************************
-
-.. danger:: This endpoint doesn't appear to work, and so its use is strongly
discouraged! The below documentation cannot be verified, therefore it may be
inaccurate and/or incomplete!
-
-``GET``
-=======
-Retrieves detailed and summary metrics for Mid-tier and Edge-tier caches
assigned to a :term:`Delivery Service`.
-
-:Auth. Required: Yes
-:Roles Required: None
-:Response Type: Array
-
-Request Structure
------------------
-.. table:: Request Path Parameters
-
-
+------------------+----------+-----------------------------------------------------------------------------+
- | Name | Required |
Description |
-
+==================+==========+=============================================================================+
- | ``id`` | yes | The delivery service id.
|
-
+------------------+----------+-----------------------------------------------------------------------------+
- | ``server_types`` | yes | EDGE or MID.
|
-
+------------------+----------+-----------------------------------------------------------------------------+
- | ``metric_types`` | yes | One of the following: "kbps", "tps",
"tps_2xx", "tps_3xx", "tps_4xx", |
- | | | "tps_5xx".
|
-
+------------------+----------+-----------------------------------------------------------------------------+
- | ``start_date`` | yes | UNIX time
|
-
+------------------+----------+-----------------------------------------------------------------------------+
- | ``end_date`` | yes | UNIX time
|
-
+------------------+----------+-----------------------------------------------------------------------------+
-
-.. table:: Request Query Parameters
-
-
+------------------+----------+-----------------------------------------------------------------------------+
- | Name | Required |
Description |
-
+==================+==========+=============================================================================+
- | ``stats`` | no | Flag used to return only summary
metrics |
-
+------------------+----------+-----------------------------------------------------------------------------+
-
-Response Structure
-------------------
-+----------------------+--------+-------------+
-| Parameter | Type | Description |
-+======================+========+=============+
-| ``stats`` | hash | |
-+----------------------+--------+-------------+
-| ``>>count`` | int | |
-+----------------------+--------+-------------+
-| ``>>98thPercentile`` | number | |
-+----------------------+--------+-------------+
-| ``>>min`` | number | |
-+----------------------+--------+-------------+
-| ``>>max`` | number | |
-+----------------------+--------+-------------+
-| ``>>5thPercentile`` | number | |
-+----------------------+--------+-------------+
-| ``>>95thPercentile`` | number | |
-+----------------------+--------+-------------+
-| ``>>median`` | number | |
-+----------------------+--------+-------------+
-| ``>>mean`` | number | |
-+----------------------+--------+-------------+
-| ``>>stddev`` | number | |
-+----------------------+--------+-------------+
-| ``>>sum`` | number | |
-+----------------------+--------+-------------+
-| ``data`` | array | |
-+----------------------+--------+-------------+
-| ``>>item`` | array | |
-+----------------------+--------+-------------+
-| ``>>time`` | number | |
-+----------------------+--------+-------------+
-| ``>>value`` | number | |
-+----------------------+--------+-------------+
-| ``label`` | string | |
-+----------------------+--------+-------------+
-
-.. code-block:: json
- :caption: Response Example
-
- { "response": [
- {
- "stats": {
- "count": 988,
- "98thPercentile": 16589105.55958,
- "min": 3185442.975,
- "max": 17124754.257,
- "5thPercentile": 3901253.95445,
- "95thPercentile": 16013210.034,
- "median": 8816895.576,
- "mean": 8995846.31741194,
- "stddev": 3941169.83683573,
- "sum": 333296106.060112
- },
- "data": [
- [
- 1414303200000,
- 12923518.466
- ],
- [
- 1414303500000,
- 12625139.65
- ]
- ],
- "label": "MID Kbps"
- }
- ]}
-
-
diff --git a/docs/source/api/v4/deliveryservices_id_servers.rst
b/docs/source/api/v4/deliveryservices_id_servers.rst
index 9130d99..898c005 100644
--- a/docs/source/api/v4/deliveryservices_id_servers.rst
+++ b/docs/source/api/v4/deliveryservices_id_servers.rst
@@ -26,6 +26,7 @@ Retrieves properties of Edge-Tier servers assigned to a
:term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: CACHE-GROUP:READ, CDN:READ, TYPE:READ, PROFILE:READ,
DELIVERY-SERVICE:READ, SERVER:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_servers_eligible.rst
b/docs/source/api/v4/deliveryservices_id_servers_eligible.rst
index ddc763a..f51c34f 100644
--- a/docs/source/api/v4/deliveryservices_id_servers_eligible.rst
+++ b/docs/source/api/v4/deliveryservices_id_servers_eligible.rst
@@ -31,6 +31,7 @@ Retrieves properties of :term:`Edge-tier cache servers`
eligible for assignment
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DELIVERY-SERVICE:READ, SERVER:READ, CACHE-GROUP:READ,
TYPE:READ, CDN:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_id_urlkeys.rst
b/docs/source/api/v4/deliveryservices_id_urlkeys.rst
index e5e42b4..c19aebb 100644
--- a/docs/source/api/v4/deliveryservices_id_urlkeys.rst
+++ b/docs/source/api/v4/deliveryservices_id_urlkeys.rst
@@ -29,6 +29,7 @@ Retrieves URL signing keys for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DS-SECURITY-KEY:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -101,6 +102,7 @@ Deletes URL signing keys for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:DELETE, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_regexes.rst
b/docs/source/api/v4/deliveryservices_regexes.rst
index 7b46c28..2bff8db 100644
--- a/docs/source/api/v4/deliveryservices_regexes.rst
+++ b/docs/source/api/v4/deliveryservices_regexes.rst
@@ -26,6 +26,7 @@ Retrieves routing regular expressions for all :term:`Delivery
Services`.
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_required_capabilities.rst
b/docs/source/api/v4/deliveryservices_required_capabilities.rst
index c7a4098..9256163 100644
--- a/docs/source/api/v4/deliveryservices_required_capabilities.rst
+++ b/docs/source/api/v4/deliveryservices_required_capabilities.rst
@@ -25,6 +25,7 @@ Gets all associations of :term:`Server Capability` to
:term:`Delivery Services`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -108,6 +109,7 @@ Associates a :term:`Server Capability` with a
:term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: Object
.. note:: A :term:`Server Capability` can only be made required on a
:term:`Delivery Service` if its associated Servers already have that
:term:`Server Capability` assigned.
@@ -174,6 +176,7 @@ Dissociate a :term:`Server Capability` from a
:term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_sslkeys_add.rst
b/docs/source/api/v4/deliveryservices_sslkeys_add.rst
index d3213cd..2e68d1c 100644
--- a/docs/source/api/v4/deliveryservices_sslkeys_add.rst
+++ b/docs/source/api/v4/deliveryservices_sslkeys_add.rst
@@ -27,6 +27,7 @@ Allows user to upload an SSL certificate, csr, and private
key for a :term:`Deli
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
b/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
index c415249..282e31e 100644
--- a/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
+++ b/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
@@ -25,6 +25,7 @@ Generates an SSL certificate, csr, and private key for a
:term:`Delivery Service
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst
b/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst
index 1df09ae..9a1b185 100644
--- a/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst
+++ b/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst
@@ -27,6 +27,7 @@ Generates an SSL certificate and private key using
:abbr:`ACME (Automatic Certif
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:UPDATE, ACME:READ,
DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: Object (string)
Request Structure
diff --git
a/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst
b/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst
index d1f1294..e4599b3 100644
--- a/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst
+++ b/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst
@@ -27,6 +27,7 @@ Generates an SSL certificate and private key using Let's
Encrypt for a :term:`De
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_xmlid_servers.rst
b/docs/source/api/v4/deliveryservices_xmlid_servers.rst
index 145a610..d824467 100644
--- a/docs/source/api/v4/deliveryservices_xmlid_servers.rst
+++ b/docs/source/api/v4/deliveryservices_xmlid_servers.rst
@@ -25,6 +25,7 @@ Assigns :term:`cache servers` to a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:UPDATE, SERVER:UPDATE,
DELIVERY-SERVICE:READ, SERVER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_xmlid_urisignkeys.rst
b/docs/source/api/v4/deliveryservices_xmlid_urisignkeys.rst
index ebd77ff..9e4f0ca 100644
--- a/docs/source/api/v4/deliveryservices_xmlid_urisignkeys.rst
+++ b/docs/source/api/v4/deliveryservices_xmlid_urisignkeys.rst
@@ -25,6 +25,7 @@ Deletes URISigning objects for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: admin\ [#tenancy]_
+:Permissions Required: DS-SECURITY-KEY:DELETE, DS-SECURITY-KEY:READ,
DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: ``undefined``
Request Structure
@@ -48,6 +49,7 @@ Retrieves one or more URISigning objects for a delivery
service.
:Auth. Required: Yes
:Roles Required: admin\ [#tenancy]_
+:Permissions Required: DS-SECURITY-KEY:READ
:Response Type: ``undefined``
Request Structure
@@ -99,6 +101,7 @@ Assigns URISigning objects to a delivery service.
:Auth. Required: Yes
:Roles Required: admin\ [#tenancy]_
+:Permissions Required: DS-SECURITY-KEY:CREATE
:Response Type: ``undefined``
Request Structure
@@ -148,6 +151,7 @@ updates URISigning objects on a delivery service.
:Auth. Required: Yes
:Roles Required: admin\ [#tenancy]_
+:Permissions Required: DS-SECURITY-KEY:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst
b/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst
index 020e323..efc2cb5 100644
--- a/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst
+++ b/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst
@@ -25,6 +25,7 @@ Retrieves SSL keys for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DS-SECURITY-KEY:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -99,6 +100,7 @@ Response Structure
==========
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:DELETE, DELIVERY-SERVICE:READ,
DS-SECURITY-KEY:READ, DELIVERY-SERVICE:UPDATE
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
index 03dca83..a1ed492 100644
--- a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
+++ b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
@@ -29,6 +29,7 @@ Retrieves URL signing keys for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DS-SECURITY-KEY:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -76,6 +77,7 @@ Deletes URL signing keys for a :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:DELETE, DS-SECURITY-KEY:READ,
DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
diff --git
a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst
b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst
index d7e9730..0a9505b 100644
---
a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst
+++
b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_copyfromxmlid_copyfromxmlid.rst
@@ -25,6 +25,7 @@ Allows a user to copy URL signing keys from a specified
:term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:READ, DS-SECURITY-KEY:CREATE,
DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
:Response Type: Object (string)
Request Structure
diff --git
a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_generate.rst
b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_generate.rst
index c3e63ec..62f2ded 100644
--- a/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_generate.rst
+++ b/docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys_generate.rst
@@ -25,6 +25,7 @@ Generates URL signing keys for a :term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/deliveryserviceserver.rst
b/docs/source/api/v4/deliveryserviceserver.rst
index 169b358..e3c3f94 100644
--- a/docs/source/api/v4/deliveryserviceserver.rst
+++ b/docs/source/api/v4/deliveryserviceserver.rst
@@ -25,6 +25,7 @@ Retrieve information about the assignment of servers to
:term:`Delivery Services
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: SERVER:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -105,6 +106,7 @@ Assign a set of one or more servers to a :term:`Delivery
Service`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [2]_
+:Permissions Required: DELIVERY-SERVICE:READ, SERVER:READ, SERVER:UPDATE,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/deliveryserviceserver_dsid_serverid.rst
b/docs/source/api/v4/deliveryserviceserver_dsid_serverid.rst
index d4d6ada..f23ee15 100644
--- a/docs/source/api/v4/deliveryserviceserver_dsid_serverid.rst
+++ b/docs/source/api/v4/deliveryserviceserver_dsid_serverid.rst
@@ -25,6 +25,7 @@ Removes a :term:`cache server` from a :term:`Delivery
Service`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [1]_
+:Permissions Required: DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE,
SERVER:READ, SERVER:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/divisions.rst b/docs/source/api/v4/divisions.rst
index 2a99f63..77e6627 100644
--- a/docs/source/api/v4/divisions.rst
+++ b/docs/source/api/v4/divisions.rst
@@ -25,6 +25,7 @@ Returns a JSON representation of all configured
:term:`Divisions`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: DIVISION:READ
:Response Type: Array
Request Structure
@@ -93,6 +94,7 @@ Creates a new Division.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DIVISION:CREATE, DIVISION:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/divisions_id.rst
b/docs/source/api/v4/divisions_id.rst
index cf427c0..4096468 100644
--- a/docs/source/api/v4/divisions_id.rst
+++ b/docs/source/api/v4/divisions_id.rst
@@ -25,6 +25,7 @@ Updates a specific Division
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DIVISION:UPDATE, DIVISION:READ
Request Structure
@@ -85,3 +86,64 @@ Response Structure
"lastUpdated": "2018-11-29 20:10:36+00",
"name": "quest"
}}
+
+``DELETE``
+============
+Deletes a specific Division
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Permissions Required: DIVISION:DELETE, DIVISION:READ
+
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+-----------------------------------------------------------+
+ | Name | Description |
+ +======+===========================================================+
+ | ID | The integral, unique identifier of the requested Division |
+ +------+-----------------------------------------------------------+
+
+
+.. code-block:: http
+ :caption: Request Example
+
+ DELETE /api/4.0/divisions/3 HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 2
+ Content-Type: application/json
+
+ {}
+
+Response Structure
+------------------
+:id: An integral, unique identifier for this Division
+:lastUpdated: The date and time at which this Division was last modified, in
:ref:`non-rfc-datetime`
+:name: The Division 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:
yBd8MzBR/Qbc/xts44WEIFRTrqeMKZwUe2ufpm6JH6frh1UjFmYRs3/B7E5FTruFWRTuvEIlx5EpDmp3f9LjzA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Thu, 29 Nov 2018 20:10:36 GMT
+ Content-Length: 83
+
+ { "alerts": [
+ {
+ "text": "division was deleted.",
+ "level": "success"
+ }
+ ]}
diff --git a/docs/source/api/v4/federation_resolvers.rst
b/docs/source/api/v4/federation_resolvers.rst
index 5ee2fa6..0e14ba9 100644
--- a/docs/source/api/v4/federation_resolvers.rst
+++ b/docs/source/api/v4/federation_resolvers.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Federation` Resolvers.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: FEDERATION-RESOLVER:READ, TYPE:READ
:Response Type: Array
Request Structure
@@ -103,6 +104,7 @@ Creates a new federation resolver.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION-RESOLVER:CREATE, TYPE:READ
:Response Type: Object
Request Structure
@@ -172,6 +174,7 @@ Deletes a federation resolver.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION-RESOLVER:DELETE, TYPE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/federations.rst
b/docs/source/api/v4/federations.rst
index a46611e..daabb48 100644
--- a/docs/source/api/v4/federations.rst
+++ b/docs/source/api/v4/federations.rst
@@ -25,6 +25,7 @@ Retrieves a list of :term:`Federation` mappings (i.e.
:term:`Federation` Resolve
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: FEDERATION-RESOLVER:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -85,6 +86,7 @@ Allows a user to create :term:`Federation` Resolvers for
:term:`Delivery Service
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: FEDERATION-RESOLVER:CREATE, FEDERATION-RESOLVER:READ,
DELIVERY-SERVICE:READ
:Response Type: Object (string)
Request Structure
@@ -151,6 +153,7 @@ Deletes **all** :term:`Federation` Resolvers associated
with the logged-in user'
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: FEDERATION-RESOLVER:DELETE
:Response Type: Object (string)
Request Structure
@@ -194,10 +197,11 @@ Response Structure
``PUT``
=======
-Replaces **all** :term:`Federations` associated with a user's :term:`Delivery
Service`\ (s) with those defined inside the request payload.
+Replaces **all** :term:`Federations` Resolvers associated with a user's
:term:`Delivery Service`\ (s) with those defined inside the request payload.
:Auth. Required: Yes
:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Permissions Required: FEDERATION-RESOLVER:DELETE, FEDERATION-RESOLVER:CREATE,
DELIVERY-SERVICE:READ
:Response Type: Object (string)
Request Structure
diff --git a/docs/source/api/v4/federations_all.rst
b/docs/source/api/v4/federations_all.rst
index 97b4608..53d0e00 100644
--- a/docs/source/api/v4/federations_all.rst
+++ b/docs/source/api/v4/federations_all.rst
@@ -25,6 +25,7 @@ Retrieves a list of :term:`Federation` mappings (also called
:term:`Federation`
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION-RESOLVER:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/federations_id_deliveryservices.rst
b/docs/source/api/v4/federations_id_deliveryservices.rst
index 7c68550..a1a1f47 100644
--- a/docs/source/api/v4/federations_id_deliveryservices.rst
+++ b/docs/source/api/v4/federations_id_deliveryservices.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Delivery Services` assigned to a
:term:`Federation`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: FEDERATION:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -105,6 +106,7 @@ Assigns one or more :term:`Delivery Services` to a
federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, DELIVERY-SERVICE:UPDATE,
FEDERATION:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/federations_id_deliveryservices_id.rst
b/docs/source/api/v4/federations_id_deliveryservices_id.rst
index 46671ca..2203543 100644
--- a/docs/source/api/v4/federations_id_deliveryservices_id.rst
+++ b/docs/source/api/v4/federations_id_deliveryservices_id.rst
@@ -25,6 +25,7 @@ Removes a :term:`Delivery Service` from a federation. A
:term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, DELIVERY-SERVICE:UPDATE,
FEDERATION:READ, DELIVERY-SERVICE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/federations_id_federation_resolvers.rst
b/docs/source/api/v4/federations_id_federation_resolvers.rst
index c567649..1bfa799 100644
--- a/docs/source/api/v4/federations_id_federation_resolvers.rst
+++ b/docs/source/api/v4/federations_id_federation_resolvers.rst
@@ -25,6 +25,7 @@ Retrieves federation resolvers assigned to a federation.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: FEDERATION:READ, FEDERATION-RESOLVER:READ
:Response Type: Array
Request Structure
@@ -88,6 +89,7 @@ Assigns one or more resolvers to a federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, FEDERATION:READ,
FEDERATION-RESOLVER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/federations_id_users.rst
b/docs/source/api/v4/federations_id_users.rst
index 2fe0675..b7d8719 100644
--- a/docs/source/api/v4/federations_id_users.rst
+++ b/docs/source/api/v4/federations_id_users.rst
@@ -25,6 +25,7 @@ Retrieves users assigned to a federation.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: FEDERATION:READ, USER:READ
:Response Type: Array
Request Structure
@@ -103,6 +104,7 @@ Assigns one or more users to a federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, USER:READ, FEDERATION:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/federations_id_users_id.rst
b/docs/source/api/v4/federations_id_users_id.rst
index 7ec3aa2..4296fa3 100644
--- a/docs/source/api/v4/federations_id_users_id.rst
+++ b/docs/source/api/v4/federations_id_users_id.rst
@@ -25,6 +25,7 @@ Removes a user from a federation.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: FEDERATION:UPDATE, FEDERATION:READ, USER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/isos.rst b/docs/source/api/v4/isos.rst
index e538c90..c24ca44 100644
--- a/docs/source/api/v4/isos.rst
+++ b/docs/source/api/v4/isos.rst
@@ -26,6 +26,7 @@ Generates an ISO from the requested ISO source.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ISO:GENERATE, ISO:READ
:Response Type: undefined - ISO image as a streaming download
Request Structure
diff --git a/docs/source/api/v4/jobs.rst b/docs/source/api/v4/jobs.rst
index 2695431..ed9f822 100644
--- a/docs/source/api/v4/jobs.rst
+++ b/docs/source/api/v4/jobs.rst
@@ -25,6 +25,7 @@ Retrieve content invalidation jobs.
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: JOB:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -114,6 +115,7 @@ Creates a new content invalidation job.
:Auth. Required: Yes
:Roles Required: "operations" or "admin"\ [#tenancy]_
+:Permissions Required: JOB:CREATE, JOB:READ, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
@@ -210,6 +212,7 @@ Replaces an existing content invalidation job with a new
one provided in the req
:Auth. Required: Yes
:Roles Required: "operations" or "admin"\ [#tenancy]_
+:Permissions Required: JOB:UPDATE, DELIVERY-SERVICE:UPDATE, JOB:READ,
DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -315,6 +318,7 @@ Deletes a content invalidation job.
:Auth. Required: Yes
:Roles Required: "operations" or "admin"\ [#tenancy]_
+:Permissions Required: JOB:DELETE, JOB:READ, DELIVERY-SERVICE:UPDATE,
DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/letsencrypt_autorenew.rst
b/docs/source/api/v4/letsencrypt_autorenew.rst
index bf33acb..d79a367 100644
--- a/docs/source/api/v4/letsencrypt_autorenew.rst
+++ b/docs/source/api/v4/letsencrypt_autorenew.rst
@@ -25,6 +25,7 @@ Generates an SSL certificate and private key using Let's
Encrypt for a :term:`De
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:CREATE, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/letsencrypt_dnsrecords.rst
b/docs/source/api/v4/letsencrypt_dnsrecords.rst
index dfe3a15..1295cff 100644
--- a/docs/source/api/v4/letsencrypt_dnsrecords.rst
+++ b/docs/source/api/v4/letsencrypt_dnsrecords.rst
@@ -25,6 +25,7 @@ Gets DNS challenge records for Let's Encrypt DNS challenge
for a specified :abbr
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DS-SECURITY-KEY:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/logs.rst b/docs/source/api/v4/logs.rst
index ac7ce82..c714ebb 100644
--- a/docs/source/api/v4/logs.rst
+++ b/docs/source/api/v4/logs.rst
@@ -26,6 +26,7 @@ Fetches a list of changes that have been made to the Traffic
Control system
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: LOG:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/logs_newcount.rst
b/docs/source/api/v4/logs_newcount.rst
index 29cf97b..b74573f 100644
--- a/docs/source/api/v4/logs_newcount.rst
+++ b/docs/source/api/v4/logs_newcount.rst
@@ -28,6 +28,7 @@ Gets the number of new changes made to the Traffic Control
system - "new" being
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: LOG:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/origins.rst b/docs/source/api/v4/origins.rst
index 97f15b5..6003859 100644
--- a/docs/source/api/v4/origins.rst
+++ b/docs/source/api/v4/origins.rst
@@ -25,6 +25,7 @@ Gets all requested :term:`Origins`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: ORIGIN:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -144,6 +145,7 @@ Creates a new origin definition.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ORIGIN:CREATE, ORIGIN:READ, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
@@ -257,6 +259,7 @@ Updates an :term:`Origin` definition.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ORIGIN:UPDATE, ORIGIN:READ, DELIVERY-SERVICE:READ,
DELIVERY-SERVICE:UPDATE
:Response Type: Object
Request Structure
@@ -375,6 +378,7 @@ Deletes an :term:`Origin` definition.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: ORIGIN:DELETE, DELIVERY-SERVICE:UPDATE
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/osversions.rst
b/docs/source/api/v4/osversions.rst
index eb14de8..e4b4cfb 100644
--- a/docs/source/api/v4/osversions.rst
+++ b/docs/source/api/v4/osversions.rst
@@ -26,6 +26,7 @@ Gets all available :abbr:`OS (Operating System)` versions for
ISO generation, as
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: ISO:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/parameterprofile.rst
b/docs/source/api/v4/parameterprofile.rst
index 1647761..47a4166 100644
--- a/docs/source/api/v4/parameterprofile.rst
+++ b/docs/source/api/v4/parameterprofile.rst
@@ -25,6 +25,7 @@ Create one or more :term:`Parameter`/:term:`Profile`
assignments.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:UPDATE, PROFILE:READ, PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/parameters.rst
b/docs/source/api/v4/parameters.rst
index 0c994c8..90ba968 100644
--- a/docs/source/api/v4/parameters.rst
+++ b/docs/source/api/v4/parameters.rst
@@ -25,6 +25,7 @@ Gets all :term:`Parameters` configured in Traffic Ops
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PARAMETER:READ
:Response Type: Array
Request Structure
@@ -111,6 +112,7 @@ Creates one or more new :term:`Parameters`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PARAMETER:CREATE, PARAMETER:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/parameters_id.rst
b/docs/source/api/v4/parameters_id.rst
index af738a4..d79153e 100644
--- a/docs/source/api/v4/parameters_id.rst
+++ b/docs/source/api/v4/parameters_id.rst
@@ -25,6 +25,7 @@ Replaces a :term:`Parameter`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PARAMETER:UPDATE, PARAMETER:READ
:Response Type: Object
Request Structure
@@ -107,6 +108,7 @@ Deletes the specified :term:`Parameter`. If, however, the
:term:`Parameter` is a
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PARAMETER:DELETE, PARAMETER:READ,
:Response TYpe: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/phys_locations.rst
b/docs/source/api/v4/phys_locations.rst
index 56e1be6..fe163bd 100644
--- a/docs/source/api/v4/phys_locations.rst
+++ b/docs/source/api/v4/phys_locations.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Physical Locations`
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PHYSICAL-LOCATION:READ
:Response Type: Array
Request Structure
@@ -120,6 +121,7 @@ Creates a new physical location
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PHYSICAL-LOCATION:CREATE, PHYSICAL-LOCATION:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/phys_locations_id.rst
b/docs/source/api/v4/phys_locations_id.rst
index b60d6bd..fff3232 100644
--- a/docs/source/api/v4/phys_locations_id.rst
+++ b/docs/source/api/v4/phys_locations_id.rst
@@ -25,6 +25,7 @@ Updates a :term:`Physical Location`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PHYSICAL-LOCATION:UPDATE, PHYSICAL-LOCATION:READ
:Response Type: Array
Request Structure
@@ -138,6 +139,7 @@ Deletes a :term:`Physical Location`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PHYSICAL-LOCATION:DELETE, PHYSICAL-LOCATION:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/plugins.rst b/docs/source/api/v4/plugins.rst
index 73066e8..95e24af 100644
--- a/docs/source/api/v4/plugins.rst
+++ b/docs/source/api/v4/plugins.rst
@@ -26,6 +26,7 @@ Retrieves the list of configured enabled Traffic Ops plugins.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PLUGIN:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/profileparameter.rst
b/docs/source/api/v4/profileparameter.rst
index e7cbf01..cbe652a 100644
--- a/docs/source/api/v4/profileparameter.rst
+++ b/docs/source/api/v4/profileparameter.rst
@@ -26,6 +26,7 @@ Create one or more :term:`Profile`/:term:`Parameter`
assignments.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:READ, PARAMETER:READ, PROFILE:UPDATE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profileparameters.rst
b/docs/source/api/v4/profileparameters.rst
index 5db85df..5ca1adb 100644
--- a/docs/source/api/v4/profileparameters.rst
+++ b/docs/source/api/v4/profileparameters.rst
@@ -26,6 +26,7 @@ Retrieves all :term:`Parameter`/:term:`Profile` assignments.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PROFILE:READ, PARAMETER:READ
:Response Type: Array
Request Structure
@@ -91,7 +92,8 @@ Associate a :term:`Parameter` to a :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
-:Response Type: Object
+:Response Type: Object
+:Permissions Required: PROFILE:READ, PARAMETER:READ, PROFILE:UPDATE
Request Structure
-----------------
diff --git a/docs/source/api/v4/profileparameters_profileID_parameterID.rst
b/docs/source/api/v4/profileparameters_profileID_parameterID.rst
index 854a174..a48e20c 100644
--- a/docs/source/api/v4/profileparameters_profileID_parameterID.rst
+++ b/docs/source/api/v4/profileparameters_profileID_parameterID.rst
@@ -25,6 +25,7 @@ Deletes a :term:`Profile`/:term:`Parameter` association.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:UPDATE, PROFILE:READ, PARAMETER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/profiles.rst b/docs/source/api/v4/profiles.rst
index b65b57f..2b61218 100644
--- a/docs/source/api/v4/profiles.rst
+++ b/docs/source/api/v4/profiles.rst
@@ -23,6 +23,7 @@
=======
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PROFILE:READ
:Response Type: Array
Request Structure
@@ -95,6 +96,7 @@ Creates a new :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:CREATE, PROFILE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profiles_id.rst
b/docs/source/api/v4/profiles_id.rst
index 06b6fb8..3b901d4 100644
--- a/docs/source/api/v4/profiles_id.rst
+++ b/docs/source/api/v4/profiles_id.rst
@@ -25,6 +25,7 @@ Replaces the specified :term:`Profile` with the one in the
request payload
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:UPDATE, PROFILE:READ
:Response Type: Object
Request Structure
@@ -114,6 +115,7 @@ Allows user to delete a :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:DELETE, PROFILE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/profiles_id_export.rst
b/docs/source/api/v4/profiles_id_export.rst
index 75f5102..bd28ad2 100644
--- a/docs/source/api/v4/profiles_id_export.rst
+++ b/docs/source/api/v4/profiles_id_export.rst
@@ -24,6 +24,7 @@
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PROFILE:READ, PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profiles_id_parameters.rst
b/docs/source/api/v4/profiles_id_parameters.rst
index 7aebf8f..da2c84e 100644
--- a/docs/source/api/v4/profiles_id_parameters.rst
+++ b/docs/source/api/v4/profiles_id_parameters.rst
@@ -26,6 +26,7 @@ Retrieves all :term:`Parameters` assigned to the
:term:`Profile`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PROFILE:READ, PARAMETER:READ
:Response Type: Array
Request Structure
@@ -106,6 +107,7 @@ Associates :term:`Parameters` to a :term:`Profile`. If the
:term:`Parameter` doe
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:UPDATE, PROFILE:READ, PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profiles_import.rst
b/docs/source/api/v4/profiles_import.rst
index 455b587..0422314 100644
--- a/docs/source/api/v4/profiles_import.rst
+++ b/docs/source/api/v4/profiles_import.rst
@@ -28,6 +28,7 @@ Imports a :term:`Profile` that was exported via
:ref:`to-api-profiles-id-export`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:CREATE, PARAMETER:CREATE, PROFILE:READ,
PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profiles_name_name_copy_copy.rst
b/docs/source/api/v4/profiles_name_name_copy_copy.rst
index 64bea3a..2426e54 100644
--- a/docs/source/api/v4/profiles_name_name_copy_copy.rst
+++ b/docs/source/api/v4/profiles_name_name_copy_copy.rst
@@ -25,6 +25,7 @@ Copy :term:`Profile` to a new :term:`Profile`. The new
:term:`Profile`'s :ref:`p
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:CREATE, PROFILE:READ, PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/profiles_name_name_parameters.rst
b/docs/source/api/v4/profiles_name_name_parameters.rst
index fd83827..6f3711e 100644
--- a/docs/source/api/v4/profiles_name_name_parameters.rst
+++ b/docs/source/api/v4/profiles_name_name_parameters.rst
@@ -25,6 +25,7 @@ Retrieves all :term:`Parameters` associated with a given
:term:`Profile`
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: PROFILE:READ, PARAMETER:READ
:Response Type: None
Request Structure
@@ -104,6 +105,7 @@ Associates :term:`Parameters` to a :term:`Profile`. If the
:term:`Parameter` doe
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: PROFILE:UPDATE, PROFILE:READ, PARAMETER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/regions.rst b/docs/source/api/v4/regions.rst
index 2b0195c..fc6dc63 100644
--- a/docs/source/api/v4/regions.rst
+++ b/docs/source/api/v4/regions.rst
@@ -25,6 +25,7 @@ Retrieves information about :term:`Regions`
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: REGION:READ
:Response Type: Object
Request Structure
@@ -102,6 +103,7 @@ Creates a new region
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: REGION:CREATE, REGION:READ
:Response Type: Object
Request Structure
@@ -172,6 +174,7 @@ Deletes a region. If no query parameter is specified, a
``400 Bad Request`` resp
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: REGION:DELETE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/regions_id.rst
b/docs/source/api/v4/regions_id.rst
index 7833cf6..ce7dcb2 100644
--- a/docs/source/api/v4/regions_id.rst
+++ b/docs/source/api/v4/regions_id.rst
@@ -25,6 +25,7 @@ Updates a :term:`Region`.
:Auth. Required: Yes
:Role(s) Required: "admin" or "operator"
+:Permissions Required: REGION:UPDATE, REGION:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/roles.rst b/docs/source/api/v4/roles.rst
index 3618d92..15c4d97 100644
--- a/docs/source/api/v4/roles.rst
+++ b/docs/source/api/v4/roles.rst
@@ -25,6 +25,7 @@ Retrieves all user :term:`Roles`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: ROLE:READ
:Response Type: Array
Request Structure
@@ -137,6 +138,7 @@ Creates a new :term:`Role`.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ROLE:CREATE, ROLE:READ
:Response Type: Object
Request Structure
@@ -203,6 +205,7 @@ Replaces an existing :term:`Role` with one provided by the
request.
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ROLE:UPDATE, ROLE:READ
:Response Type:
Request Structure
@@ -285,6 +288,7 @@ Deletes a :term:`Role`
:Auth. Required: Yes
:Roles Required: "admin"
+:Permissions Required: ROLE:DELETE, ROLE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/server_capabilities.rst
b/docs/source/api/v4/server_capabilities.rst
index 3a732ae..4b55261 100644
--- a/docs/source/api/v4/server_capabilities.rst
+++ b/docs/source/api/v4/server_capabilities.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Server Capabilities`.
:Auth. Required: Yes
:Roles Required: "read-only"
+:Permissions Required: SERVER-CAPABILITY:READ
:Response Type: Array
Request Structure
@@ -81,6 +82,7 @@ Create a new :term:`Server Capability`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER-CAPABILITY:CREATE, SERVER-CAPABILITY:READ
:Response Type: Object
Request Structure
@@ -141,6 +143,7 @@ Update an existing :term:`Server Capability`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER-CAPABILITY:UPDATE, SERVER-CAPABILITY:READ
:Response Type: Object
Request Structure
@@ -201,6 +204,7 @@ Deletes a specific :term:`Server Capability`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER-CAPABILITY:DELETE, SERVER-CAPABILITY:READ
:Response Type: ``undefined``
diff --git a/docs/source/api/v4/server_server_capabilities.rst
b/docs/source/api/v4/server_server_capabilities.rst
index e076431..9c37b23 100644
--- a/docs/source/api/v4/server_server_capabilities.rst
+++ b/docs/source/api/v4/server_server_capabilities.rst
@@ -25,6 +25,7 @@ Gets all associations of :term:`Server Capabilities` to
:term:`cache servers`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER:READ, SERVER-CAPABILITY:READ
:Response Type: Array
Request Structure
@@ -106,6 +107,7 @@ Associates a :term:`Server Capability` to a server.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:UPDATE, SERVER:READ, SERVER-CAPABILITY:READ
:Response Type: Object
Request Structure
@@ -174,6 +176,7 @@ Disassociate a server from a :term:`Server Capability`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:UPDATE, SERVER:READ, SERVER-CAPABILITY:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/servercheck.rst
b/docs/source/api/v4/servercheck.rst
index 40b9b42..ec96cbe 100644
--- a/docs/source/api/v4/servercheck.rst
+++ b/docs/source/api/v4/servercheck.rst
@@ -27,6 +27,7 @@ Fetches identifying and meta information as well as "check"
values regarding all
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER-CHECK:READ, SERVER:READ
:Response Type: Array
Request Structure
@@ -105,6 +106,7 @@ Post a server check result to the "serverchecks" table.
Updates the resulting va
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: SERVER-CHECK:CREATE, SERVER-CHECK:READ, SERVER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/servercheck_extensions.rst
b/docs/source/api/v4/servercheck_extensions.rst
index f7774c3..a797c51 100644
--- a/docs/source/api/v4/servercheck_extensions.rst
+++ b/docs/source/api/v4/servercheck_extensions.rst
@@ -26,6 +26,7 @@ Retrieves the list of Traffic Ops extensions.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER-CHECK:READ, SERVER:READ
:Response Type: Array
Request Structure
@@ -136,6 +137,7 @@ Creates a new Traffic Ops check extension.
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: SERVER-CHECK:CREATE, SERVER-CHECK:READ, SERVER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/servercheck_extensions_id.rst
b/docs/source/api/v4/servercheck_extensions_id.rst
index 92734bb..dfaa581 100644
--- a/docs/source/api/v4/servercheck_extensions_id.rst
+++ b/docs/source/api/v4/servercheck_extensions_id.rst
@@ -25,6 +25,7 @@ Deletes a Traffic Ops server check extension definition. This
does **not** delet
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: SERVER-CHECK:DELETE, SERVER-CHECK:READ, SERVER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/servers.rst b/docs/source/api/v4/servers.rst
index 35069f2..c68d5cb 100644
--- a/docs/source/api/v4/servers.rst
+++ b/docs/source/api/v4/servers.rst
@@ -25,6 +25,7 @@ Retrieves properties of all servers across all CDNs.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER:READ, DELIVERY-SERVICE:READ, CDN:READ,
PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
:Response Type: Array
Request Structure
@@ -236,6 +237,7 @@ Allows a user to create a new server.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:CREATE, SERVER:READ, DELIVERY-SERVICE:READ,
CDN:READ, PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/servers_details.rst
b/docs/source/api/v4/servers_details.rst
index 4056543..afc95ed 100644
--- a/docs/source/api/v4/servers_details.rst
+++ b/docs/source/api/v4/servers_details.rst
@@ -25,6 +25,7 @@ Retrieves details of :ref:`tp-configure-servers`.
=======
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER:READ, DELIVERY-SERVICE:READ, CDN:READ,
PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
:Response Type: Array
.. note:: On top of the response including the response key that is of type
array it will also include the keys ``limit``, ``orderby``, and ``size``.
diff --git a/docs/source/api/v4/servers_hostname_update.rst
b/docs/source/api/v4/servers_hostname_update.rst
index e0501c8..96158c7 100644
--- a/docs/source/api/v4/servers_hostname_update.rst
+++ b/docs/source/api/v4/servers_hostname_update.rst
@@ -25,6 +25,7 @@
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:UPDATE, SERVER:READ
:Response Type: undefined
Request Structure
diff --git a/docs/source/api/v4/servers_hostname_update_status.rst
b/docs/source/api/v4/servers_hostname_update_status.rst
index 3187e57..6c63328 100644
--- a/docs/source/api/v4/servers_hostname_update_status.rst
+++ b/docs/source/api/v4/servers_hostname_update_status.rst
@@ -27,6 +27,7 @@ Retrieves information regarding pending updates and
revalidation jobs for a give
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVER:READ
:Response Type: Array
.. versionchanged:: 4.0
diff --git a/docs/source/api/v4/servers_id.rst
b/docs/source/api/v4/servers_id.rst
index 206f170..23ea9ed 100644
--- a/docs/source/api/v4/servers_id.rst
+++ b/docs/source/api/v4/servers_id.rst
@@ -25,6 +25,7 @@ Allow user to edit a server.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:UPDATE, SERVER:READ, DELIVERY-SERVICE:READ,
CDN:READ, PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
:Response Type: Object
Request Structure
@@ -326,6 +327,7 @@ Allow user to delete server through api.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:DELETE, SERVER:READ, DELIVERY-SERVICE:READ,
CDN:READ, PHYSICAL-LOCATION:READ, CACHE-GROUP:READ, TYPE:READ, PROFILE:READ
:Response Type: Object
.. versionchanged:: 3.0
diff --git a/docs/source/api/v4/servers_id_deliveryservices.rst
b/docs/source/api/v4/servers_id_deliveryservices.rst
index 7add8a8..69112b9 100644
--- a/docs/source/api/v4/servers_id_deliveryservices.rst
+++ b/docs/source/api/v4/servers_id_deliveryservices.rst
@@ -25,6 +25,7 @@ Retrieves all :term:`Delivery Services` assigned to a
specific server.
:Auth. Required: Yes
:Roles Required: None\ [#tenancy]_
+:Permissions Required: DELIVERY-SERVICE:READ, SERVER:READ
:Response Type: Array
Request Structure
@@ -256,6 +257,7 @@ Assign an arbitrary number of :term:`Delivery Services` to
a single server.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: DELIVERY-SERVICE:READ, SERVER:READ,
DELIVERY-SERVICE:UPDATE, SERVER:UPDATE
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/servers_id_queue_update.rst
b/docs/source/api/v4/servers_id_queue_update.rst
index 758ce19..ff28ec0 100644
--- a/docs/source/api/v4/servers_id_queue_update.rst
+++ b/docs/source/api/v4/servers_id_queue_update.rst
@@ -26,6 +26,7 @@
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:QUEUE, SERVER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/servers_id_status.rst
b/docs/source/api/v4/servers_id_status.rst
index 31b45f4..40f7171 100644
--- a/docs/source/api/v4/servers_id_status.rst
+++ b/docs/source/api/v4/servers_id_status.rst
@@ -25,6 +25,7 @@ Updates server status and queues updates on all descendant
:term:`Topology` node
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:UPDATE, SERVER:READ, STATUS:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/servicecategories.rst
b/docs/source/api/v4/service_categories.rst
similarity index 82%
rename from docs/source/api/v4/servicecategories.rst
rename to docs/source/api/v4/service_categories.rst
index 7720691..a65a086 100644
--- a/docs/source/api/v4/servicecategories.rst
+++ b/docs/source/api/v4/service_categories.rst
@@ -26,6 +26,7 @@ Get all requested :term:`Service Categories`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: SERVICE-CATEGORY:READ
:Response Type: Array
Request Structure
@@ -95,6 +96,7 @@ Create a new service category.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVICE-CATEGORY:CREATE, SERVICE-CATEGORY:READ
:Response Type: Object
Request Structure
@@ -148,54 +150,3 @@ Response Structure
"name": "SERVICE_CATEGORY_NAME"
}
}
-
-``DELETE``
-==========
-Deletes a specific :term:`Service Category`.
-
-:Auth. Required: Yes
-:Roles Required: "admin" or "operations"
-:Response Type: ``undefined``
-
-
-Request Structure
------------------
-
-.. code-block:: http
- :caption: Request Example
-
- DELETE /api/4.0/service_categories/my-service-category HTTP/1.1
- User-Agent: python-requests/2.23.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, 17 Aug 2020 16:13:31
GMT; Max-Age=3600; HttpOnly
- Whole-Content-Sha512:
yErJobzG9IA0khvqZQK+Yi7X4pFVvOqxn6PjrdzN5DnKVm/K8Kka3REul1XmKJnMXVRY8RayoEVGDm16mBFe4Q==
- X-Server-Name: traffic_ops_golang/
- Date: Mon, 17 Aug 2020 15:13:31 GMT
- Content-Length: 93
-
- {
- "alerts": [
- {
- "text": "serviceCategory was deleted.",
- "level": "success"
- }
- ]
- }
diff --git a/docs/source/api/v4/service_categories_name.rst
b/docs/source/api/v4/service_categories_name.rst
new file mode 100644
index 0000000..6ae9e37
--- /dev/null
+++ b/docs/source/api/v4/service_categories_name.rst
@@ -0,0 +1,149 @@
+..
+..
+.. 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-service-categories-name:
+
+*******************************
+``service_categories/{{name}}``
+*******************************
+
+``PUT``
+========
+Update a service category.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Permissions Required: SERVICE-CATEGORY:UPDATE, SERVICE-CATEGORY:READ
+:Response Type: Object
+
+Request Structure
+-----------------
+:name: The :term:`Service Category`'s new name
+
+.. table:: Request Path Parameters
+
+
+------------+------------------------------------------------------------------------+
+ | Name | Description
|
+
+============+========================================================================+
+ | name | The current name of the :term:`Service Category`
|
+
+------------+------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/4.0/service_categories/sc-name 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": "New Name",
+ }
+
+Response Structure
+------------------
+:name: This :term:`Service Category`'s name
+:lastUpdated: The date and time at which this :term:`Service Category` was
last modified, 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:
+pJm4c3O+JTaSXNt+LP+u240Ba/SsvSSDOQ4rDc6hcyZ0FIL+iY/WWrMHhpLulRGKGY88bM4YPCMaxGn3FZ9yQ==
+ X-Server-Name: traffic_ops_golang/
+ Date: Wed, 11 Mar 2020 20:12:20 GMT
+ Content-Length: 189
+
+ {
+ "alerts": [
+ {
+ "text": "Service Category was updated.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "lastUpdated": "2020-03-11 14:12:20-06",
+ "name": "New Name"
+ }
+ }
+
+``DELETE``
+==========
+Deletes a specific :term:`Service Category`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Permissions Required: SERVICE-CATEGORY:DELETE, SERVICE-CATEGROY:READ
+:Response Type: ``undefined``
+
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+
+------------+------------------------------------------------------------------------+
+ | Name | Description
|
+
+============+========================================================================+
+ | name | The current name of the :term:`Service Category` to be
deleted |
+
+------------+------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ DELETE /api/4.0/service_categories/my-service-category HTTP/1.1
+ User-Agent: python-requests/2.23.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, 17 Aug 2020 16:13:31
GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512:
yErJobzG9IA0khvqZQK+Yi7X4pFVvOqxn6PjrdzN5DnKVm/K8Kka3REul1XmKJnMXVRY8RayoEVGDm16mBFe4Q==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 17 Aug 2020 15:13:31 GMT
+ Content-Length: 103
+
+ {
+ "alerts": [
+ {
+ "text": "my-service-category was deleted.",
+ "level": "success"
+ }
+ ]
+ }
diff --git a/docs/source/api/v4/snapshot.rst b/docs/source/api/v4/snapshot.rst
index 4d4818b..b0a7001 100644
--- a/docs/source/api/v4/snapshot.rst
+++ b/docs/source/api/v4/snapshot.rst
@@ -28,6 +28,7 @@ This also changes the output of the
:ref:`to-api-cdns-name-configs-monitoring` e
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: CDN-SNAPSHOT:CREATE, CDN-SNAPSHOT:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/staticdnsentries.rst
b/docs/source/api/v4/staticdnsentries.rst
index 7cfffe6..d4927d2 100644
--- a/docs/source/api/v4/staticdnsentries.rst
+++ b/docs/source/api/v4/staticdnsentries.rst
@@ -25,6 +25,7 @@ Retrieve all static DNS entries configured within Traffic
Control
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STATIC-DN:READ, CACHE-GROUP:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
@@ -129,6 +130,7 @@ Creates a new, static DNS entry.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: STATIC-DN:CREATE, STATIC-DN:READ, CACHE-GROUP:READ,
DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
@@ -324,6 +326,7 @@ Delete staticdnsentries.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: STATIC-DN:DELETE, STATIC-DN:READ,
DELIVERY-SERVICE:READ, CACHE-GROUP:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/stats_summary.rst
b/docs/source/api/v4/stats_summary.rst
index bfe115d..1d8dd45 100644
--- a/docs/source/api/v4/stats_summary.rst
+++ b/docs/source/api/v4/stats_summary.rst
@@ -29,6 +29,7 @@ If the parameter is set it will return an object with the
latest timestamp, else
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STAT:READ, CDN:READ, DELIVERY-SERVICE:READ
:Response Type: Array or Object
Request Structure
@@ -185,6 +186,7 @@ Post a stats summary for a given stat.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STAT:CREATE, STAT:READ, CDN:READ, DELIVERY-SERVICE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/statuses.rst b/docs/source/api/v4/statuses.rst
index 2c2e766..02833d4 100644
--- a/docs/source/api/v4/statuses.rst
+++ b/docs/source/api/v4/statuses.rst
@@ -25,6 +25,7 @@ Retrieves a list of all server :term:`Statuses`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STATUS:READ
:Response Type: Array
Request Structure
@@ -94,3 +95,64 @@ Response Structure
"name": "REPORTED"
}
]}
+
+``POST``
+==========
+Creates a Server :term:`Status`.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Permissions Required: STATUS:CREATE, STATUS:READ
+:Response Type: Array
+
+Request Structure
+-----------------
+:description: Create a :term:`Status` with this description
+:name: Create a :term:`Status` with this name
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/4.0/statuses HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+
+ { "description": "test", "name": "example" }
+
+Response Structure
+------------------
+:description: A short description of the status
+:id: The integral, unique identifier of this status
+:lastUpdated: The date and time at which this status was last modified, in
:ref:`non-rfc-datetime`
+:name: The name of the status
+
+.. 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:
dHNip9kpTGGS1w39/fWcFehNktgmXZus8XaufnmDpv0PyG/3fK/KfoCO3ZOj9V74/CCffps7doEygWeL/xRtKA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 10 Dec 2018 20:56:59 GMT
+ Content-Length: 167
+
+ { "alerts": [
+ {
+ "text": "status was created.",
+ "level": "success"
+ }
+ ],"response": [
+ {
+ "description": "test",
+ "name": "example"
+ "id": 3,
+ "lastUpdated": "2018-12-10 19:11:17+00",
+ }
+ ]}
diff --git a/docs/source/api/v4/statuses.rst
b/docs/source/api/v4/statuses_id.rst
similarity index 73%
copy from docs/source/api/v4/statuses.rst
copy to docs/source/api/v4/statuses_id.rst
index 2c2e766..a48d790 100644
--- a/docs/source/api/v4/statuses.rst
+++ b/docs/source/api/v4/statuses_id.rst
@@ -13,11 +13,11 @@
.. limitations under the License.
..
-.. _to-api-statuses:
+.. _to-api-statuses-id:
-************
-``statuses``
-************
+*********************
+``statuses/{{ID}}``
+*********************
``GET``
=======
@@ -25,6 +25,7 @@ Retrieves a list of all server :term:`Statuses`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STATUS:READ
:Response Type: Array
Request Structure
@@ -58,7 +59,7 @@ Request Structure
.. code-block:: http
:caption: Request Example
- GET /api/4.0/statuses?name=REPORTED HTTP/1.1
+ GET /api/4.0/statuses/3 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
@@ -94,3 +95,64 @@ Response Structure
"name": "REPORTED"
}
]}
+
+``PUT``
+=======
+Updates a :term:`Status`.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Permissions Required: STATUS:UPDATE, STATUS:READ
+:Response Type: Array
+
+Request Structure
+-----------------
+:description: The description of the updated :term:`Status`
+:name: The name of the updated :term:`Status`
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/4.0/statuses/3 HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+
+ { "description": "test", "name": "example" }
+
+Response Structure
+------------------
+:description: A short description of the status
+:id: The integral, unique identifier of this status
+:lastUpdated: The date and time at which this status was last modified, in
:ref:`non-rfc-datetime`
+:name: The name of the status
+
+.. 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:
dHNip9kpTGGS1w39/fWcFehNktgmXZus8XaufnmDpv0PyG/3fK/KfoCO3ZOj9V74/CCffps7doEygWeL/xRtKA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 10 Dec 2018 20:56:59 GMT
+ Content-Length: 167
+
+ { "alerts": [
+ {
+ "text": "status was created.",
+ "level": "success"
+ }
+ ],"response": [
+ {
+ "description": "test",
+ "name": "example"
+ "id": 3,
+ "lastUpdated": "2018-12-10 19:11:17+00",
+ }
+ ]}
diff --git a/docs/source/api/v4/steering.rst b/docs/source/api/v4/steering.rst
index 72abb18..e367fe7 100644
--- a/docs/source/api/v4/steering.rst
+++ b/docs/source/api/v4/steering.rst
@@ -25,6 +25,7 @@ Gets a list of all :ref:`Steering Targets <steering-qht>` in
the Traffic Ops dat
:Auth. Required: Yes
:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Permissions Required: STEERING:READ, DELIVERY-SERVICE:READ
:Response Type: Array
Request Structure
diff --git a/docs/source/api/v4/steering_id_targets.rst
b/docs/source/api/v4/steering_id_targets.rst
index bd63fd5..890248b 100644
--- a/docs/source/api/v4/steering_id_targets.rst
+++ b/docs/source/api/v4/steering_id_targets.rst
@@ -25,6 +25,7 @@ Get all targets for a steering :term:`Delivery Service`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: STEERING:READ, DELIVERY-SERVICE:READ, TYPE:READ
:Response Type: Array
Request Structure
@@ -109,6 +110,7 @@ Create a steering target.
:Auth. Required: Yes
:Roles Required: Portal, Steering, Federation, "operations" or "admin"
+:Permissions Required: STEERING:CREATE, STEERING:READ, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/steering_id_targets_targetID.rst
b/docs/source/api/v4/steering_id_targets_targetID.rst
index e0fd111..ec036fb 100644
--- a/docs/source/api/v4/steering_id_targets_targetID.rst
+++ b/docs/source/api/v4/steering_id_targets_targetID.rst
@@ -25,6 +25,7 @@ Updates a steering target.
:Auth. Required: Yes
:Roles Required: Portal, Steering, Federation, "operations" or "admin"
+:Permissions Required: STEERING:UPDATE, STEERING:READ, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: Object
Request Structure
@@ -105,6 +106,7 @@ Removes a specific target mapping from a specific
:term:`Delivery Service`
:Auth. Required: Yes
:Roles Required: Portal, Steering, Federation, "operations" or "admin"
+:Permissions Required: STEERING:DELETE, STEERING:READ, DELIVERY-SERVICE:READ,
TYPE:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/system_info.rst
b/docs/source/api/v4/system_info.rst
index c6db5e7..2531a5e 100644
--- a/docs/source/api/v4/system_info.rst
+++ b/docs/source/api/v4/system_info.rst
@@ -23,6 +23,7 @@
=======
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: None
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/tenants.rst b/docs/source/api/v4/tenants.rst
index eea222b..2b15f36 100644
--- a/docs/source/api/v4/tenants.rst
+++ b/docs/source/api/v4/tenants.rst
@@ -25,6 +25,7 @@ Get all requested :term:`Tenants`.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: TENANT:READ
:Response Type: Array
Request Structure
@@ -105,6 +106,7 @@ Create a new tenant.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TENANT:CREATE, TENANT:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/tenants_id.rst
b/docs/source/api/v4/tenants_id.rst
index 63f7be0..046c4cb 100644
--- a/docs/source/api/v4/tenants_id.rst
+++ b/docs/source/api/v4/tenants_id.rst
@@ -25,6 +25,7 @@ Updates a specific tenant.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TENANT:UPDATE, TENANT:READ
:Response Type: Object
Request Structure
@@ -100,6 +101,7 @@ Deletes a specific tenant.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TENANT:DELETE, TENANT:READ
:Response Type: ``undefined``
diff --git a/docs/source/api/v4/topologies.rst
b/docs/source/api/v4/topologies.rst
index e317653..51fd414 100644
--- a/docs/source/api/v4/topologies.rst
+++ b/docs/source/api/v4/topologies.rst
@@ -25,6 +25,7 @@ Retrieves :term:`Topologies`.
:Auth. Required: Yes
:Roles Required: "read-only"
+:Permissions Required: TOPOLOGY:READ, CACHE-GROUP:READ
:Response Type: Array
Request Structure
@@ -152,6 +153,7 @@ Create a new :term:`Topology`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TOPOLOGY:CREATE, TOPOLOGY:READ, CACHE-GROUP:READ
:Response Type: Object
Request Structure
@@ -540,6 +542,7 @@ Deletes a specific :term:`Topology`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TOPOLOGY:DELETE, TOPOLOGY:READ, CACHE-GROUP:READ
:Response Type: ``undefined``
diff --git a/docs/source/api/v4/topologies_name_queue_update.rst
b/docs/source/api/v4/topologies_name_queue_update.rst
index d9ebff0..904dcdd 100644
--- a/docs/source/api/v4/topologies_name_queue_update.rst
+++ b/docs/source/api/v4/topologies_name_queue_update.rst
@@ -25,6 +25,7 @@
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: SERVER:QUEUE, TOPOLOGY:READ, SERVER:READ,
CACHE-GROUP:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/types.rst b/docs/source/api/v4/types.rst
index 044fc39..a659265 100644
--- a/docs/source/api/v4/types.rst
+++ b/docs/source/api/v4/types.rst
@@ -25,6 +25,7 @@ Retrieves all of the :term:`Types` of things configured in
Traffic Ops. Yes, tha
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: TYPE:READ
:Response Type: Array
Request Structure
@@ -89,6 +90,7 @@ Creates a type
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TYPE:CREATE, TYPE:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/types_id.rst b/docs/source/api/v4/types_id.rst
index 098f889..2a8a14b 100644
--- a/docs/source/api/v4/types_id.rst
+++ b/docs/source/api/v4/types_id.rst
@@ -25,6 +25,7 @@ Updates a type
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TYPE:UPDATE, TYPE:READ
:Response Type: Object
Request Structure
@@ -105,6 +106,7 @@ Deletes a type
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: TYPE:DELETE, TYPE:READ
:Response Type: Object
diff --git a/docs/source/api/v4/user_current.rst
b/docs/source/api/v4/user_current.rst
index 667a14d..3efe4a8 100644
--- a/docs/source/api/v4/user_current.rst
+++ b/docs/source/api/v4/user_current.rst
@@ -27,6 +27,7 @@ Retrieves the details of the authenticated user.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: None
:Response Type: Object
Request Structure
@@ -108,6 +109,7 @@ Updates the date for the authenticated user.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: None
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/user_login.rst
b/docs/source/api/v4/user_login.rst
index 633da4a..e2ef28b 100644
--- a/docs/source/api/v4/user_login.rst
+++ b/docs/source/api/v4/user_login.rst
@@ -25,6 +25,7 @@ Authentication of a user using username and password. Traffic
Ops will send back
:Auth. Required: No
:Roles Required: None
+:Permissions Required: None
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/user_login_oauth.rst
b/docs/source/api/v4/user_login_oauth.rst
index b3bf683..90a2db6 100644
--- a/docs/source/api/v4/user_login_oauth.rst
+++ b/docs/source/api/v4/user_login_oauth.rst
@@ -25,6 +25,7 @@ Authentication of a user by exchanging a code for an
encrypted JSON Web Token fr
:Auth. Required: No
:Roles Required: None
+:Permissions Required: None
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/user_login_token.rst
b/docs/source/api/v4/user_login_token.rst
index 1a1103b..d5fb250 100644
--- a/docs/source/api/v4/user_login_token.rst
+++ b/docs/source/api/v4/user_login_token.rst
@@ -25,6 +25,7 @@ Authentication of a user using a token. Normally, the token
is obtained via a ca
:Auth. Required: No
:Roles Required: None
+:Permissions Required: None
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/user_logout.rst
b/docs/source/api/v4/user_logout.rst
index 0d0c108..c6efff0 100644
--- a/docs/source/api/v4/user_logout.rst
+++ b/docs/source/api/v4/user_logout.rst
@@ -25,6 +25,7 @@ User logout. Invalidates the session cookie of the currently
logged-in user.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: None
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/user_reset_password.rst
b/docs/source/api/v4/user_reset_password.rst
index 1720eb4..6b6bedc 100644
--- a/docs/source/api/v4/user_reset_password.rst
+++ b/docs/source/api/v4/user_reset_password.rst
@@ -25,6 +25,7 @@ Sends an email to reset a user's password.
:Auth. Required: No
:Roles Required: None
+:Permissions Required: None
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/users.rst b/docs/source/api/v4/users.rst
index 92fd924..5df71a1 100644
--- a/docs/source/api/v4/users.rst
+++ b/docs/source/api/v4/users.rst
@@ -25,6 +25,7 @@ Retrieves all requested users.
:Auth. Required: Yes
:Roles Required: None\ [1]_
+:Permissions Required: USER:READ
:Response Type: Array
Request Structure
@@ -143,6 +144,7 @@ Creates a new user.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"\ [1]_
+:Permissions Required: USER:CREATE, USER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/users_id.rst b/docs/source/api/v4/users_id.rst
index 233ce55..a668d70 100644
--- a/docs/source/api/v4/users_id.rst
+++ b/docs/source/api/v4/users_id.rst
@@ -25,6 +25,7 @@ Retrieves a specific user.
:Auth. Required: Yes
:Roles Required: None
+:Permissions Required: USER:READ
:Response Type: Array
Request Structure
@@ -119,6 +120,7 @@ Response Structure
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: USER:UPDATE, USER:READ
:Response Type: Object
Request Structure
diff --git a/docs/source/api/v4/users_register.rst
b/docs/source/api/v4/users_register.rst
index e770a65..376d2cd 100644
--- a/docs/source/api/v4/users_register.rst
+++ b/docs/source/api/v4/users_register.rst
@@ -25,6 +25,7 @@ Register a user and send registration email.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
+:Permissions Required: USER:CREATE, USER:READ
:Response Type: ``undefined``
Request Structure
diff --git a/docs/source/api/v4/vault_ping.rst
b/docs/source/api/v4/vault_ping.rst
index 9acec6d..e5d86ee 100644
--- a/docs/source/api/v4/vault_ping.rst
+++ b/docs/source/api/v4/vault_ping.rst
@@ -24,6 +24,7 @@ Pings Traffic Vault to retrieve status.
:Auth. Required: Yes
:Roles Required: "read-only"
+:Permissions Required: TRAFFIC-VAULT:READ
:Response Type: Object
Request Structure
