Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 2.99 KB

snapshot.rst

File metadata and controls

76 lines (63 loc) · 2.99 KB

snapshot

PUT

Performs a CDN :term:`Snapshot`. Effectively, this propagates the new configuration of the CDN to its operating state, which replaces the output of the :ref:`to-api-v3-cdns-name-snapshot` endpoint with the output of the :ref:`to-api-v3-cdns-name-snapshot-new` endpoint. This also changes the output of the :ref:`to-api-v3-cdns-name-configs-monitoring` endpoint since that endpoint returns the latest monitoring information from the operating state.

Note

By default, snapshotting the CDN also deletes all HTTPS certificates for every :term:`Delivery Service` which has been deleted since the last :term:`Snapshot`. In order to disable this behavior, set disable_auto_cert_deletion in :ref:`cdn.conf` to true.

Auth. Required:Yes
Roles Required:"admin" or "operations"
Response Type:undefined

Request Structure

Request Query Parameters
Name Description
cdn The name of the CDN for which a :term:`Snapshot` shall be taken
cdnID The id of the CDN for which a :term:`Snapshot` shall be taken

Note

At least one query parameter must be given.

PUT /api/3.0/snapshot?cdn=CDN-in-a-Box HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: gmaWI0tKgNFPYO0zMrLCGDosBJkPbeIvW4BH9tEh96VjBqyWqzjgPySoMa3ViM1BQXA6VAUOGmc76VyhBsaTzA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 18 Mar 2020 15:51:48 GMT
Content-Length: 47

{
        "response": "SUCCESS"
}