snapshot

PUT

Performs a CDN Snapshot. Effectively, this propagates the new configuration of the CDN to its operating state, which replaces the output of the cdns/{{name}}/snapshot endpoint with the output of the cdns/{{name}}/snapshot/new endpoint. This also changes the output of the 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 Delivery Service which has been deleted since the last Snapshot. In order to disable this behavior, set disable_auto_cert_deletion in cdn.conf to true.

Auth. Required

Yes

Roles Required

“admin” or “operations”

Permissions Required

CDN-SNAPSHOT:CREATE, CDN-SNAPSHOT:READ

Response Type

undefined

Request Structure

Table 413 Request Query Parameters

Name

Description

cdn

The name of the CDN for which a Snapshot shall be taken

cdnID

The id of the CDN for which a Snapshot shall be taken

Note

At least one query parameter must be given.

#997 Request Example
PUT /api/4.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

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

{
    "response": "SUCCESS"
}