system.access¶

Summary¶

Resource	Operation	Description
System-Access	PUT /api/app/v1/sys/access	Enable/Disable SSH
	GET /api/app/v1/sys/access	Get SSH status

PUT /api/app/v1/sys/access¶

Enable or disable SSH access.

New in version 1.0.

Query Parameters:
	enabled (required) – (true, false)
Response Headers:
	Content-Type – application/json
Status Codes:	200 OK – Success - SSH enabled/disabled 401 Unauthorized – Access Denied
Accepted Authorization:
	admin

Example 1 - Request: Enable SSH:

PUT /api/app/v1/sys/access?enabled=True HTTP/1.1
Accept: text/html

Example 1 - Response: Enable SSH:

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

{
  "enabled": true
}

Example 1 - Request: Disable SSH:

PUT /api/app/v1/sys/access?enabled=False HTTP/1.1
Accept: application/json

Example 1 - Response: Disable SSH:

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

{
  "enabled": false
}

GET /api/app/v1/sys/access¶

Get the configured SSH status.

New in version 1.0.

Response Headers:
	Content-Type – application/json
Status Codes:	200 OK – Success - SSH status 401 Unauthorized – Access Denied
Accepted Authorization:
	admin, audit

Example 1 - Request: Get SSH status:

GET /api/app/v1/sys/access HTTP/1.1
Accept: text/html

Example 1 - Response: Get SSH status:

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

{
  "enabled": "True"
}