security

Summary

Resource Operation Description
Security GET /api/app/v1/security/(input_type) Get security settings
  PUT /api/app/v1/security/(input_type) Set security settings
  PUT /api/app/v1/security/restore/defaults Restore security defaults
  GET /api/app/v1/security/status Get security settings job status

Details

GET /api/app/v1/security/(input_type)

Retrieve security settings for CLI (SSH), API, or SSO

New in version 1.0.

Warning

This call for security settings is not available on appliance version 8.5.2 or earlier.

Response Headers:
 
Status Codes:
Accepted Authorization:
 

admin, audit

Example 1 - Request: Get security settings:

GET /api/app/v1/security/api HTTP/1.1
Accept: text/html

Example 1 - Response: Get security settings:

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

{

“ssl_ciphers”: “AES:AES128-SHA256”, “ssl_protocols”: “TLSv1.2”

}
PUT /api/app/v1/security/(input_type)

Set security settings for CLI (SSH), API, and SSO.

New in version 1.0.

Warning

This call to set security settings is not available on appliance version 8.5.2 or earlier.

Parameters:
  • protocol (optional) – Value of protocol to be set
  • cipher (optional) – Value of cipher to be set
Response Headers:
 
Status Codes:
Accepted Authorization:
 

admin, audit

Example 1 - Request: Set security settings:

PUT /api/app/v1/security/api?protocol=TLSv1.2 HTTP/1.1
Accept: text/html

Example 1 - Response: Set security settings:

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

{
  "job_id": "20180806111232015557"
}
PUT /api/app/v1/security/restore/defaults

Restore security default settings for CLI (SSH), API, and SSO.

New in version 1.0.

Warning

This call to restore security default settings is not available on appliance version 8.5.2 or earlier.

Response Headers:
 
Status Codes:
Accepted Authorization:
 

admin, audit

Example 1 - Request: Restore security defaults:

PUT /api/app/v1/security/restore/defaults?type=all HTTP/1.1
Accept: text/html

Example 1 - Response: Restore security defaults:

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

{
  "sso_job_id": "20180806111232015557"
  "api_job_id": "20180806111232015558"
  "cli_job_id": "20180806111232015559"
}

Example 2 - Request: Restore security defaults:

PUT /api/app/v1/security/restore/defaults?type=sso HTTP/1.1
Accept: text/html

Example 2 - Response: Restore security defaults:

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

{
  "sso_job_id": "20180806111232015557"
}
GET /api/app/v1/security/status

Retrieves job status for a set of security settings for CLI (SSH), API, and SSO.

New in version 1.0.

Warning

This call to get a security settings status is not available on appliance version 8.5.2 or earlier.

Parameters:
  • protocol (optional) – Value of protocol to be set
  • cipher (optional) – Value of cipher to be set
Response Headers:
 
Status Codes:
Accepted Authorization:
 

admin, audit

Example 1 - Request: Get security settings job status:

PUT /api/app/v1/security/status?jid=20180803152057785532 HTTP/1.1
Accept: text/html

Example 1 - Response: Get security settings job status:

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

{
  "status": "Service was successfully restarted.  Settings file saved and in use."
}