config_summary

Summary

Resource	Operation	Description
Config Summary	GET /api/app/v1/configsummary/download	Download config summary file
	PUT /api/app/v1/configsummary/generate	Generate a config summary
	PUT /api/app/v1/configsummary/save	Generate/save config summary
	GET /api/app/v1/configsummary/status	Status of generation of config summary file

Details

GET /api/app/v1/configsummary/download

Download the specified config summary file.

Accepts:

text/html

Query Parameters:  

• filename (required) – Config summary file to download.

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Success -File successfully downloaded
• 400 Bad Request – Bad Request - Invalid parameters
• 401 Unauthorized – Access Denied
• 404 Not Found – Not found - file not found

Example 1 - Request: Download config summary file:

GET /api/app/v1/configsummary/download?filename=<VALID_CS_FILE>.enc HTTP/1.1
Accept: text/html

Example 1 - Response: Download config summary file:

HTTP/1.1 200 OK
Content-Type: application/octetstring

<Encrypted Config Summary File>

Example 2 - Request: Invalid config summary file:

GET api/app/v1/configsummary/download?filename=<INVALID_CS_FILE>.enc HTTP/1.1
Accept: text/html

Example 2 - Response: Invalid config summary file:

HTTP/1.1 401 OK
Content-Type: application/json

{
 "Reason": "<CONFIG_SUMMARY_FILE>.enc does not exist",
 "Status": "Failure"
}

PUT /api/app/v1/configsummary/generate

Generate the config summary file for download.

Accepts:

text/html

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Success -Config summary was generated
• 401 Unauthorized – Access Denied

Accepted Authorization:  

admin

Example 1 - Request: Generate config summary file:

PUT /api/app/v1/configsummary/generate HTTP/1.1
Accepts: text/html

Example 1 - Response: Generate config summary file:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Filename": "<NAME_OF_CONFIGSUM_FILE>.enc"
}

PUT /api/app/v1/configsummary/save

Generate and save config summary file to filestore server.

Accepts:

application/json

Query Parameters:  

• location (optional) – Location of filestore; filestore alias
• url (required) – URL of the location in which to store the config summary

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Success -Config summary successfully saved
• 400 Bad Request – Bad Request - Invalid parameters
• 401 Unauthorized – Access Denied
• 404 Not Found – Not found - Invalid filestore
• 422 Unprocessable Entity – Unprocessable - Config sumary not successfully saved

Accepted Authorization:  

admin

Example 1 - Request: Save config summary to filestore:

PUT /api/app/v1/configsummary/save?location=<VALID_FS_ALIAS> HTTP/1.1
Accepts: text/html

Example 1 - Response: Save config summary to filestore:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Info": "'<CONFIG_SUMMARY>.enc' has been saved to <FILESTORE_PATH>."
}

Example 2 - Request: Invalid filestore alias:

PUT /api/app/v1/configsummary/save?location=<INVALID_FILESTORE_ALIAS> HTTP/1.1
Accepts: text/html

Example 2 - Response: Invalid filestore alias:

HTTP/1.1 400 OK
Content-Type: application/json

{
  "Reason": "Alias <INVALID_FILESTORE_ALIAS> does not exist.",
  "Status": "Failure"
}

GET /api/app/v1/configsummary/status

Get status of generation of config summary file. If not generating, returns last successful generation if it exists.

Accepts:

text/html.

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Success - Status of process, and if not process, the last known good file if exists.

Example 1 - Request: Download config summary file:

GET /api/app/v1/configsummary/download?filename=<VALID_CS_FILE>.enc HTTP/1.1
Accept: text/html

Example 1 - Response: No file generating. Last known good file exists.:

HTTP/1.1 200 OK
Content-Type: application/json

  {
    "Filename": "FpTs_v.email.22.14_20180404113502.enc",
    "Generated Time": "2018-04-04 11:35:18",
    "Status": false
  }

Example 2 - Response: No file generating. No last known file exists.:

HTTP/1.1 200 OK
Content-Type: application/json

  {
    "Filename": null,
    "Generated Time": null,
    "Status": false
  }

Example 3 - Response: File is generating.:

HTTP/1.1 200 OK
Content-Type: application/json

  {
    "Status": true
  }