Skylar Compliance API

The REST API for Skylar Compliance (formerly Restorepoint) — ScienceLogic's network configuration and change management product. 314 operations across 193 paths covering devices, configuration backups, backup diffing and restore, compliance policies and rules, discovery, credentials, firmware and template push, agents, jobs, users, roles and appliance settings. ScienceLogic states that the product's own web interface uses this same API for every operation. The API is served by the customer's own Skylar Compliance appliance at /api/v2.

Documentation Provider Profile APIs.io OpenAPI GitHub

Skylar Compliance API is one of 5 APIs that ScienceLogic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Compliance, Network Configuration Management, and Backup. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 314 operations across 193 paths, organized into 74 resource areas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, /api/v2.

314 operations 193 paths 0 schemas 41 DELETE126 GET3 PATCH91 POST53 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2.0

Base URL

https://{appliance}/api/v2

Authentication

API Key, API Key, OpenID Connect

Resource Areas

Authentication & Security 3

Skylar Compliance API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as session (Cookie). An API key is passed in the header as Authorization (Token). It supports OpenID Connect (Permissions) discovered at https://ignore.example.com. By default, every request must be authenticated.

Cookie — The Skylar Compliance web interface uses session cookies to authenticate API requests coming from a user's browser. Please use authentication tokens when integ…
Token — To integrate with the Skylar Compliance API, please use the web interface to create API tokens. API requests via token should pass an Authorization header usin…
Permissions — Lists required [Permissions](tag/Permission) for each individual endpoint. Please note: Whilst this authentication method is listed as an OpenID Connect authen…

Paths & Operations 314

Across 193 paths, the API surfaces 314 operations — 41 DELETE, 126 GET, 3 PATCH, 91 POST, 53 PUT. They span 74 resource areas, including Agent, Agent/Debug, Agent/Remote, Backup, Command, Command/Schedule, Command/Output, Command/Variables, and 66 more. Each is listed below with its method, path, parameters, and response codes.

Agent 6

Agents allow a Skylar Compliance appliance to manage devices located on a remote or otherwise disjointed network, not directly routable by Skylar Compliance, without the need of c…

GET

/agents

List agents

list_agents 8 params → 200

POST

/agents

Create an agent

create_agent body → 200400403

GET

/agents/{id}

Retrieve an agent

get_agent 1 param → 200404

PUT

/agents/{id}

Update an agent

update_agent 1 param body → 200400404

DELETE

/agents/{id}

Delete an agent

delete_agent 1 param → 204404

GET

/agents/{id}/info

Get agent info

get_agent_info 1 param → 200

Agent/Debug 4

Endpoints that can aid in debugging agent problems.

POST

/agents/{id}/debug

Start debug logging

start_agent_debug 1 param → 204

PUT

/agents/{id}/debug

Stop debug logging

stop_agent_debug 1 param → 204

GET

/agents/{id}/debug

Get agent debug state

get_agent_debug_state 1 param → 200

GET

/agents/{id}/debug/log

View debug log

get_agent_debug_log 1 param → 200

Agent/Remote 2

Start and stop remote support access on agents.

POST

/agents/{id}/remote

Start remote access

start_agent_remote 1 param → 200

PUT

/agents/{id}/remote

Stop remote access

stop_agent_remote 1 param → 204

Backup 1

A device backup can encapsulates one or more device configurations. Depending on the type of device, a device backup might be a simple text file or a multi-gigabyte TGZ.

GET

/backups

List backups

list_backups 9 params → 200

Command 7

Skylar Compliance allows you to send a CLI command to a device or group of devices and capture the output of the command. This is a very convenient tool to perform a task concurre…

GET

/commands

List commands

list_commands 9 params → 200

POST

/commands

Create a command

create_command body → 200400

POST

/commands/perform

Perform a command ad-hoc, without saving the command into the database

perform_adhoc_command body → 200400

GET

/commands/{id}

Retrieve a command

get_command 1 param → 200404

PUT

/commands/{id}

Update a command

update_command 1 param body → 200400404

DELETE

/commands/{id}

Delete a command

delete_command 1 param → 204404

POST

/commands/{id}/perform

Perform command

perform_command 1 param body → 200400404

Command/Schedule 6

Commands can be scheduled to run automatically at defined intervals or once.

GET

/commands/schedules

List all schedules

list_command_schedules 4 params → 200

GET

/commands/{id}/schedules

List schedules by command id

list_command_schedules_by_command_id 6 params → 200

POST

/commands/{id}/schedules

Create a schedule

create_command_schedule 1 param body → 200400

GET

/commands/{id}/schedules/{schedule_id}

Retrieve a schedule

get_command_schedule 2 params → 200404

PUT

/commands/{id}/schedules/{schedule_id}

Update a schedule

update_command_schedule 2 params body → 200400404

DELETE

/commands/{id}/schedules/{schedule_id}

Delete a schedule

delete_command_schedule 2 params → 204404

Command/Output 13

Logs from running [scheduled commands](tag/CommandSchedule) with StoreLog enabled can be retrieved here.

GET

/commands/outputs

List command outputs

list_outputs 10 params → 200400500

GET

/commands/outputs/{id}

Retrieve a command output

get_output 1 param → 200400404500

DELETE

/commands/outputs/{id}

Delete a command output

delete_output 1 param → 204404

GET

/commands/outputs/{id}/content

Retrieve paginated content lines for a command output

get_output_content 2 params → 200400404500

POST

/commands/outputs/{id}/download

Download a command output

download_output 1 param → 200404

GET

/commands/outputs/{id}/export

Export a command output

export_output 2 params → 200404500

POST

/commands/outputs/diff

Compare outputs

diff_output body → 200400404500

GET

/commands/outputs/settings

Get command output settings

get_command_output_settings → 200

PUT

/commands/outputs/settings

Set command output settings

update_command_output_settings body → 200400

DELETE

/commands/outputs/groups/{id}

Delete a command output group

delete_output_group 1 param → 204400404500

GET

/commands/outputs/grouped

List grouped command outputs

list_grouped_outputs 8 params → 200400500

GET

/commands/outputs/grouped/{id}

Retrieve a grouped command output

get_grouped_output 3 params → 200400404500

GET

/commands/outputs/grouped/{outputGroupId}/export

Export a grouped command output

export_grouped_output 2 params → 200404500

Command/Variables 1

Commands can have one or multiple variables. The user can upload a csv file with a list of variables and they will be parsed and used when running the command.

POST

/commands/variables/csv

Parses a csv file and returns a list of command variables

parse_command_variables_from_csv body → 200400500

Credential 5

Set of username and up to two passwords that can be used across multiple devices.

GET

/credentials

List credentials

list_credentials 6 params → 200

POST

/credentials

Create credentials

create_credential body → 200400

GET

/credentials/{id}

Retrieve credentials

get_credential 1 param → 200404

PUT

/credentials/{id}

Update credentials

update_credential 1 param body → 200400404

DELETE

/credentials/{id}

Delete credentials

delete_credential 1 param → 204404

Credential/Bulk 2

Allows creating or updating multiple credentials at once. It will create a scheduled task with the given credentials and create a log entry for the beginning and end of the creden…

POST

/credentials/bulk

Create credentials in bulk

bulk_create_credentials body → 202400

PUT

/credentials/bulk

Update credentials in bulk

bulk_update_credentials body → 202400

Credential/Provider/CyberArk 5

Allows retrieving credentials from the external vault.

GET

/credentials/providers/cyberark

List CyberArk providers

list_cyberark_providers 3 params → 200

POST

/credentials/providers/cyberark

Create CyberArk provider

create_cyberark_provider body → 200400

GET

/credentials/providers/cyberark/{id}

Retrieve CyberArk provider

get_cyberark_provider 1 param → 200404

PUT

/credentials/providers/cyberark/{id}

Update CyberArk provider

update_cyberark_provider 1 param body → 200400404

DELETE

/credentials/providers/cyberark/{id}

Delete CyberArk provider

delete_cyberark_provider 1 param → 204404

Device 16

Devices are Skylar Compliance's representation of physical or virtual network devices.

GET

/devices

List devices

list_devices 52 params → 200

POST

/devices

Create a device

create_device body → 200400403

PATCH

/devices

Patch multiple devices

patch_devices body → 200400422

GET

/devices/{id}

Retrieve a device

get_device 1 param → 200404

PUT

/devices/{id}

Update a device

update_device 1 param body → 200400404

DELETE

/devices/{id}

Delete a device

delete_device 1 param → 204403404

GET

/devices/{id}/monitors

Retrieve monitor measurements

monitor_device 3 params → 200400

DELETE

/devices/{id}/knownhosts

Clear SSH known hosts

clear_known_hosts 1 param → 204404

GET

/devices/{id}/compliance

Test device compliance

device_compliance 2 params → 200400404

GET

/devices/{id}/plugincommand/{command}

Perform a plugin command on a device

device_plugin_command 2 params → 200400404500

POST

/devices/search

Global search

global_search body → 200

POST

/devices/import

Import devices

import_devices body → 200400

POST

/devices/export

Export devices

export_devices body → 200400

POST

/devices/test

Test device login

test_device body → 200400

GET

/devices/count

Get total number of devices grouped by some device field

get_device_counters 43 params → 200

POST

/devices/{id}/assetfields/{assetfield_id}/upload

Upload a file for an assetfield

upload_assetfield_file 2 params body → 204400404

Device/Backup 10

A device backup can encapsulates one or more device configurations. Depending on the type of device, a device backup might be a simple text file or a multi-gigabyte TGZ.

POST

/devices/backups/diff

Compare backups

diff_backup body → 200400

GET

/devices/{id}/backups

List backups for a device

list_device_backups 6 params → 200

POST

/devices/{id}/backups

Trigger a manual backup

create_backup 1 param → 204

POST

/devices/{id}/backups/import

Import a backup

import_backup 1 param body → 200400

POST

/devices/{id}/backups/export

Export a backup

export_backup 1 param body → 200400

GET

/devices/{id}/backups/{backup_id}

Retrieve backup details

get_backup 2 params → 200404

PUT

/devices/{id}/backups/{backup_id}

Update backup details

update_backup 2 params body → 200400404

DELETE

/devices/{id}/backups/{backup_id}

Delete a backup

delete_backup 3 params → 204404

POST

/devices/{id}/backups/{backup_id}/config

Configuration details

config_details 4 params body → 200400

POST

/devices/{id}/backups/{backup_id}/restore

Restore a backup

restore_backup 2 params body → 204400

Device/BulkEdit 3

Allows editing multiple devices at once. This losely follows the structure of the [Device](tag/Device) model. Skylar Compliance will aggregate values for individual settings. Stri…

POST

/devices/bulk

Retrieve multiple devices for editing

retrieve_bulk_device body → 200400

PATCH

/devices/bulk

Update multiple devices

save_bulk_device 1 param body → 200202400

POST

/devices/bulk/schedule

Spread device schedules

schedule_devices body → 200400

Device/BulkCreate 1

Allows creating multiple devices at once. It will create a scheduled task with the given devices and create a log entry for each device creation and one when all the devices are c…

POST

/devices/bulk/create

Create devices in bulk

bulk_create_devices body → 202400

Dictionary 1

Dictionaries for various auto-complete and search filter settings.

GET

/dictionaries/{type}

Retrieve a dictionary

list_dictionary 1 param → 200404

Discovery 3

The Skylar Compliance device discovery engine uses a variety of methods to discover hosts on your network that can be imported into the main device list. You can also be notified…

POST

/discovery

Run device discovery

run_discovery → 204

POST

/discovery/import

Import discovered devices

import_discovery body → 204400

POST

/discovery/rescan

Rescan discovered devices

rescan_discovery body → 204400

Discovery/Device 2

New devices as discovered by a manual or scheduled device discovery run will appear here.

GET

/discovery/devices

List discovered devices

list_discovered_devices 6 params → 200

PATCH

/discovery/devices

Change discovered device settings

update_discovered_devices body → 204400

Domain 8

Domains allow you to organise devices into separate domains, and delegate their management to Domain Administrators. A typical use is for Service Providers managing multiple custo…

GET

/domains

List domains

list_domains 13 params → 200

POST

/domains

Create a domain

create_domain body → 200400

GET

/domains/{id}

Retrieve a domain

get_domain 1 param → 200404

PUT

/domains/{id}

Update a domain

update_domain 1 param body → 200400404

DELETE

/domains/{id}

Delete a domain

delete_domain 1 param → 204404

GET

/domains/{id}/relationships

Export domain's relationships

export_domain_relationships 1 param → 200404

GET

/domains/public

List domains (public)

list_domains_public 13 params → 200

GET

/domains/public/{id}

Retrieve a domain (public)

get_domain_public → 200404

Download 1

An endpoint to download files from.

GET

/downloads/{id}

Download a file

download 1 param → 200404

Export 1

Allows you to export device configurations, logs and settings for multiple devices or domains.

POST

/export

Create an export

create_export body → 200400

Export/Policy 5

Automatically export device configurations to a specified file server. Please do not mistake this for the [device policy export](operation/exportdevicepolicies) endpoint.

GET

/export/policies

List policies

list_export_policies 5 params → 200

POST

/export/policies

Create a policy

create_export_policy body → 200400

GET

/export/policies/{id}

Retrieve a policy

get_export_policy 1 param → 200404

PUT

/export/policies/{id}

Update a policy

update_export_policy 1 param body → 200400404

DELETE

/export/policies/{id}

Delete a policy

delete_export_policy 1 param → 204404

Fileserver 6

A file server represents a remote storage location that can be used for archiving Skylar Compliance, exporting backups and automated exports. Supported connection methods FTP SFTP…

GET

/fileservers

List fileservers

list_fileservers 5 params → 200

POST

/fileservers

Create a fileserver

create_fileserver body → 200400

GET

/fileservers/{id}

Retrieve a fileserver

get_fileserver 1 param → 200404

PUT

/fileservers/{id}

Update a fileserver

update_fileserver 1 param body → 200400404

DELETE

/fileservers/{id}

Delete a fileserver

delete_fileserver 1 param → 204404

POST

/fileservers/test

Test a fileserver

test_fileserver body → 204400

Firmware 7

Skylar Compliance can act as a repository for device firmware/software, allowing you to upload files like firmware images and ISO images to the appliance. Software images can also…

GET

/firmware

List all firmware

list_firmwares 5 params → 200

POST

/firmware

Upload firmware

upload_firmware body → 200400

GET

/firmware/{id}

Get firmware metadata

get_firmware 1 param → 200404

PUT

/firmware/{id}

Update firmware metadata

update_firmware 1 param body → 200400404

DELETE

/firmware/{id}

Delete a firmware

delete_firmware 1 param → 204404

POST

/firmware/{id}/push

Push firmware to devices

push_firmware 1 param body → 204400

POST

/firmware/export

Export firmware

export_firmware body → 200400

Job 6

Jobs represent a running task in Skylar Compliance, such as a running device backup, command or creating an archive of Skylar Compliance. Normally, a job transitions from: Pending…

GET

/jobs

List jobs

list_jobs 5 params → 200401402503504

DELETE

/jobs

Abort all

cancel_all_jobs → 204

GET

/jobs/{id}

Retrieve a job

get_job 1 param → 200404

DELETE

/jobs/{id}

Cancel a job

cancel_job 1 param → 204404

GET

/jobs/historic

List historic jobs

list_historic_jobs 5 params → 200401402503504

DELETE

/jobs/historic/{id}

Delete a historic job

delete_historic_job 1 param → 204404500

Label 5

Labels are a way of attaching meta information to devices. They allow for arbitrary grouping and selection of devices that can go beyond the use of device specific information fie…

GET

/labels

List labels

list_labels 7 params → 200500

POST

/labels

Create a label

create_label body → 200400500

GET

/labels/{id}

Retrieve a label

get_label 1 param → 200404

PUT

/labels/{id}

Update a label

update_label 1 param body → 200400404500

DELETE

/labels/{id}

Delete a label

delete_label 1 param → 204404500

The login endpoint is used by the UI to authenticate a user. On successful login, it will set a session cookie that will further authenticate API requests coming from the web inte…

GET

/login

Retrieve current login status

check_login → 200401409503

POST

/login

Authenticate a user

authenticate body → 200401503

DELETE

/login

Logout

logout → 204

PUT

/login

Update login

update_login body → 200400403

GET

/login/saml

Retrieve SAML Login URL

saml_redirect → 200

POST

/login/activation

Complete account activation

complete_activation body → 204400401403409500

PUT

/login/recovery

Set recovery question and answer

set_recovery_details body → 204400401403500

Log 3

Almost every system activity will be logged and can be retrieved

GET

/logs

List logs

list_logs 20 params → 200

GET

/logs/{id}

Retrieve a log

get_log 1 param → 200404

GET

/logs/export

Export logs

export_logs → 200

Network 4

Network utility endpoints.

POST

/network/fingerprint

Fingerprint network address

fingerprint body → 200400

POST

/network/ping

Ping a network address

ping body → 200400

POST

/network/resolve

Resolve a hostname

resolve body → 200400

POST

/network/testproxy

Tests HTTP connectivity through a proxy

test_proxy body → 200400

Permission 1

Permissions are the building blocks of what a user's role is entitled to perform. Permissions are read-only.

GET

/permissions

List permissions

list_permissions 1 param → 200

Permissions/ValidateRequest 1

POST

/permissions/validate-request

Validate a request

validate_request body → 200400

Plugin 8

Plugins have a number of device specific settings that are required for creating a functional device configurations for backup, restore or running commands.

GET

/plugins

List plugins

list_plugins 1 param → 200

GET

/plugins/{name}

Retrieve a plugin

get_plugin 1 param → 200404

GET

/plugins/{name}/defaults

Get plugin default values

get_plugin_default_values 1 param → 200404500

PUT

/plugins/{name}/defaults

Update plugin's default values. Fields not present in the request won't get persisted.

update_plugin_default_values 1 param body → 200400404500

GET

/plugins/{name}/redactrules

Get plugin redact rules

get_plugin_redact_rules 1 param → 200404500

POST

/plugins/{name}/redactrules

Create a plugin redact rule

create_plugin_redact_rule 1 param body → 201400404500

PUT

/plugins/{name}/redactrules/{id}

Update a plugin redact rule

update_plugin_redact_rule 2 params body → 200400404500

DELETE

/plugins/{name}/redactrules/{id}

Delete a plugin redact rule

delete_plugin_redact_rule 2 params → 204400404500

Policy 11

Skylar Compliance enables you to create policies that can be used to verify that your devices comply with corporate or regulatory guidelines. Policies are groups of one or more ru…

GET

/policies

List policies

list_policies 10 params → 200

POST

/policies

Create a policy

create_policy body → 200400

GET

/policies/{id}

Retrieve a policy

get_policy 1 param → 200404

PUT

/policies/{id}

Update a policy

update_policy 1 param body → 200400404

DELETE

/policies/{id}

Delete a policy

delete_policy 1 param → 204404

POST

/policies/{id}/test

Test a policy

test_policy 1 param body → 200400404

PUT

/policies/{id}/scores

Update policy's devices' compliance scores

update_policy_devices_scores 1 param body → 200404500

POST

/policies/import

Import policies

import_device_policies 2 params body → 200400

GET

/policies/export

Export policies

export_device_policies 1 param → 200400

GET

/policies/settings

Get policy settings

get_policy_settings → 200

PUT

/policies/settings

Set policy settings

update_policy_settings body → 200400

Policy/Rule 6

Rules are the individual parts of a device policy. Regular Expressions A regular expression specifies a set of strings as a pattern, rather than a list. For example, the pattern C…

POST

/policies/rules/test

Test rule

test_rule body → 200400404

GET

/policies/{id}/rules

List rules

list_rules 5 params → 200

POST

/policies/{id}/rules

Create a rule

create_rule 1 param body → 200400

GET

/policies/{id}/rules/{rule_id}

Retrieve a rule

get_rule 2 params → 200404

PUT

/policies/{id}/rules/{rule_id}

Update a rule

update_rule 2 params body → 200400404

DELETE

/policies/{id}/rules/{rule_id}

Delete a rule

delete_rule 2 params → 204404

Policy/Variable 7

Policy variables can be used in compliance rules as variable replacements, referenced with the $replace$ format, where replace is the variable name you have defined. This enables…

GET

/policies/variables

List variables

list_variables 4 params → 200

POST

/policies/variables

Create a variable

create_variable body → 200400

GET

/policies/variables/{id}

Retrieve a variable

get_variable 1 param → 200404

PUT

/policies/variables/{id}

Update a variable

update_variable 1 param body → 200400404

DELETE

/policies/variables/{id}

Delete a variable

delete_variable 1 param → 204404

POST

/policies/variables/import

Import policy variables

import_policy_variables body → 200400

GET

/policies/variables/export

Export variables

export_policy_variables 1 param → 200400

Recovery 2

POST

/recovery/password-reset

Reset password using recovery token and answer

recovery_password_reset body → 200400404500

GET

/recovery/question

Get recovery question

get_recovery_question 1 param → 200500

Report 7

GET

/reports

List reports

list_reports 5 params → 200400401500

POST

/reports

Create a report

create_report body → 200400401500

GET

/reports/assettypes

Get report asset types

get_report_assettypes → 200500

POST

/reports/adhoc

Generate an ad-hoc report

generate_adhoc_report body → 200400401500

GET

/reports/{id}

Get a report

get_report 1 param → 200400401404500

PUT

/reports/{id}

Update a report

update_report 1 param body → 200400401404500

DELETE

/reports/{id}

Delete a report

delete_report 1 param → 204400404500

Report schedule 5

GET

/reports/schedules

List report schedules

list_report_schedules 6 params → 200400401500

POST

/reports/schedules

Create a report schedule

create_report_schedule body → 200400401500

GET

/reports/schedules/{id}

Get a report schedule

get_report_schedule 1 param → 200400401404500

PUT

/reports/schedules/{id}

Update a report schedule

update_report_schedule 1 param body → 200400401404500

DELETE

/reports/schedules/{id}

Delete a report schedule

delete_report_schedule 1 param → 204400404500

Role 5

In addition to the standard built-in roles (Admin, Backup, and View Only), which cannot be edited, it is possible to define granular, custom roles, which specify in detail which p…

GET

/roles

List roles

list_roles 5 params → 200

POST

/roles

Create a role

create_role body → 200400

GET

/roles/{id}

Retrieve a role

get_role 1 param → 200404

PUT

/roles/{id}

Update a role

update_role 1 param body → 200400404

DELETE

/roles/{id}

Delete a role

delete_role 1 param → 204404

SAML 4

GET

/saml/groups

List SAML groups

list_saml_groups 4 params → 200400500

POST

/saml/groups

Create a SAML group

create_saml_group body → 200400500

PUT

/saml/groups/{id}

Update a SAML group

update_saml_group 1 param body → 200400500

DELETE

/saml/groups/{id}

Delete a SAML group

delete_saml_group 1 param → 204400500

Schedule 6

Allows a view of the next occurence of all scheduled events including device backups, Skylar Compliance archival, device discovery as well as reporting.

GET

/schedules

List all schedules

list_all_schedules 5 params → 200

POST

/schedules/nextdue

Next due

next_due body → 200400

GET

/schedules/status

Schedule status

check_schedule_status → 200

POST

/schedules/pause

Pause schedule

pause_schedule → 204

POST

/schedules/resume

Resume schedule

resume_schedule → 204

POST

/schedules/postpone

Postpone schedules

postpone_schedule body → 204400

Settings/Advanced 2

GET

/settings/advanced

Get advanced settings

get_advanced_settings → 200

PUT

/settings/advanced

Set advanced settings

update_advanced_settings body → 200400

Settings/Alerts 3

Configure system email alert settings.

GET

/settings/alerts

Get alert settings

get_alert_settings → 200

PUT

/settings/alerts

Set alert settings

update_alert_settings body → 200400

GET

/settings/alerts/test

Tests alert settings by sending a dummy email

test_alert_settings → 200400

Settings/Appliance 5

Allows you to set general appliance settings as well as triggering global appliance actions.

GET

/settings/appliance

Get appliance settings

get_appliance_settings → 200

PUT

/settings/appliance

Set appliance settings

update_appliance_settings body → 200400

DELETE

/settings/appliance/cache

Clear cache

clear_cache → 204

POST

/settings/appliance/install

Install appliance

install_appliance body → 200400

GET

/settings/appliance/install/status

Check installation status

check_install_status → 200

Settings/Appliance/Actions 3

Trigger global appliance actions.

POST

/settings/appliance/restart

Restart Skylar Compliance

restart_restorepoint → 204

POST

/settings/appliance/reboot

Reboot appliance

reboot_appliance → 204

POST

/settings/appliance/shutdown

Appliance shutdown

shutdown_appliance → 204

Settings/Appliance/Support 3

Start and stop remote support sessions.

POST

/settings/appliance/support

Start remote support

start_remote_support → 204

DELETE

/settings/appliance/support

Stop remote support

stop_remote_support → 204

GET

/settings/appliance/support

Check if remote support is active

get_remote_support → 200

Settings/Appliance/Debug 7

Endpoints that can aid in debugging appliance problems.

POST

/settings/appliance/debug

Start debug logging

start_debug → 204

PUT

/settings/appliance/debug

Stop debug logging

stop_debug → 204

GET

/settings/appliance/debug

Check if debug logging is active

get_debug → 200

GET

/settings/appliance/debug/log

Download debug log

download_debug_log → 200

DELETE

/settings/appliance/debug/log

Delete debug log

delete_debug_log → 204

GET

/settings/appliance/debug/details

Download debug details

download_debug_details → 200

GET

/settings/appliance/trace

Get stack trace

stack_trace → 200

Settings/Appliance/Updates 4

Check, retrieve and update the appliance.

GET

/settings/appliance/update

Check update status

check_update → 200

PUT

/settings/appliance/update

Update now

run_update → 204

DELETE

/settings/appliance/update

Force update check

force_check_update → 204

POST

/settings/appliance/update

Upload manual update

upload_update body → 204500

Settings/Appliance/Logo 2

Add, update or reset a custom logo for the appliance UI.

POST

/settings/appliance/logo

Upload a new logo

upload_logo body → 204500

DELETE

/settings/appliance/logo

Reset logo

reset_logo → 204

Settings/Assetfield 5

Configure device asset information fields including location, asset tag, and serial number.

GET

/settings/assetfields

List all asset fields

list_assetfields 2 params → 200

POST

/settings/assetfields

Create an asset field

create_assetfield body → 200400

GET

/settings/assetfields/{id}

Retrieve an asset field

get_assetfield 1 param → 200404

PUT

/settings/assetfields/{id}

Update an asset field

update_assetfield 1 param body → 200400403404

DELETE

/settings/assetfields/{id}

Delete an asset field

delete_assetfield 1 param → 204404

Settings/Assetfield/Notifications 3

Configure device asset notify address.

GET

/settings/assetfields/notifications

Get asset notification settings

get_asset_notification_settings → 200500

PUT

/settings/assetfields/notifications

Update asset notification settings

update_asset_notification_settings body → 204400500

DELETE

/settings/assetfields/notifications

Disable asset notifications

disable_asset_notifications → 204500

Settings/Archive 5

You can prepare for disaster recovery scenarios by archiving the Skylar Compliance configuration. This allows you to back up the Skylar Compliance appliance automatically, to up t…

GET

/settings/archive

Get archive settings

get_archive_settings → 200

PUT

/settings/archive

Set archive settings

update_archive_settings body → 200400

POST

/settings/archive/backup

Backup appliance

backup_restorepoint → 204

GET

/settings/archive/restore

List appliance backups

list_restorepoint_backups → 200

POST

/settings/archive/restore

Restore appliance

restore_restorepoint body → 204400404500

Settings/Authentication 3

Allows you to configure additional authentication methods for Skylar Compliance. Supported methods are: RADIUS SAML LDAP

GET

/settings/authentication

Get authentication settings

get_authentication_settings → 200

PUT

/settings/authentication

Set authentication settings

update_authentication_settings body → 200400

POST

/settings/authentication/testldap

Tests LDAP server

test_ldap body → 200400

Settings/Device 2

Allows you to set default device settings that are inherited whenever a new device is added but can be overriden.

GET

/settings/device

Get default device settings

get_device_settings → 200

PUT

/settings/device

Set default device settings

update_device_settings body → 200400

Settings/Discovery 2

Allows you to set device discovery settings for manual or scheduled device discovery runs.

GET

/settings/discovery

Get discovery settings

get_discovery_settings → 200

PUT

/settings/discovery

Set discovery settings

update_discovery_settings body → 200400

Settings/HA 4

High Availability (HA) provides a way to minimise the effects of hardware failure, by configuring two Skylar Compliance appliances in a cluster. Under normal operating conditions,…

GET

/settings/ha

Get HA settings

get_ha_settings → 200

PUT

/settings/ha

Set HA settings

update_ha_settings body → 200400

GET

/settings/ha/status

Cluster status

get_high_availability_status → 200401402503504

GET

/settings/ha/active

Active node health check

get_high_availability_active → 200404421

Settings/Logs 2

Allows you to configure default log rentention and other logging related settings.

GET

/settings/logs

Get log settings

get_log_settings → 200

PUT

/settings/logs

Set log settings

update_log_settings body → 200400

Settings/Network 5

Allows you to set network settings such as the IP address and static routes. Network Address Translation (NAT) Skylar Compliance may use back-connections (typically TFTP or FTP) t…

GET

/settings/network

Get network settings

get_network_settings → 200

PUT

/settings/network

Set network settings

update_network_settings body → 200400

GET

/settings/network/routes

List routes

get_routes → 200500

POST

/settings/network/routes

Add route

add_route body → 204400

DELETE

/settings/network/routes

Delete route

delete_route body → 204400500

Settings/Passwords 2

Password policies allow you to configure various rules for enforcing password strength, for both devices and users. These settings are used in the strength meter displayed in all…

GET

/settings/passwords

Get password settings

get_password_settings → 200

PUT

/settings/passwords

Set password settings

update_password_settings body → 200400

Settings/PublicKey 1

Returns the default public keys for your appliance that can be used for public key authentication with devices that support it.

GET

/settings/publickeys

List public keys

list_publickeys → 200

Settings/Security 3

Configure various global settings to mandate a higher level of network security for the Skylar Compliance appliance. Setting some of these options may cause compatibility problems…

GET

/settings/security

Get security settings

get_security_settings → 200

PUT

/settings/security

Set security settings

update_security_settings body → 200400

POST

/settings/security/reset-ssh-keys

Reset SSH Keys

reset_ssh_keys → 204500

Settings/Security/CSR 2

Manage TLS CSRs

GET

/settings/security/csr

Get TLS CSR

get_tls_csr → 200500

POST

/settings/security/csr

Generate a TLS CSR

post_tls_csr body → 201400500

Settings/Security/SSH 1

Manage SSH settings

DELETE

/settings/security/ssh/knownhosts

Clear Appliance SSH known hosts file

clear_appliance_ssh_known_hosts → 204

Settings/Security/TLS 5

Configure TLS certificate and key

GET

/settings/security/tls

Get TLS certificate details

get_tls_certificate → 200500

POST

/settings/security/tls

Generate a key and create a self-signed certificate

post_tls_certificate body → 200204400500

PUT

/settings/security/tls

Replace certificate and key

put_tls_certificate body → 204400500

PUT

/settings/security/tls/certificate

Replace certificate

put_tls_standalone_certificate body → 204400500

POST

/settings/security/tls/newkey

Generate new RSA key

post_tls_new_key body → 204400500

Settings/SNMP 2

If your network has a Network Management System, you can use SNMP to perform some basic monitoring of the Skylar Compliance appliance. Skylar Compliance supports SNMP v1, v2c, and…

GET

/settings/snmp

Get SNMP settings

get_snmp_settings → 200

PUT

/settings/snmp

Set SNMP settings

update_snmp_settings body → 200400

Status 1

Retrieve status information for the appliance.

GET

/status

System status

system_status → 200

Status/Ping 1

Check if appliance is ready to accept requests

GET

/status/ping

Check if the backend is ready to accept requests

system_status_ping → 204401402503

Syslog 1

These are the messages logged to the Skylar Compliance syslog service, by both the appliance itself and any devices configured to log to it.

GET

/syslogs

List syslog entries. If no sort param is passed, syslogs will be ordered by 'Created', in a descending method

list_syslogs 8 params → 200

Table view 5

GET

/tableviews

List table views

list_table_views 2 params → 200400500

POST

/tableviews

Create a table view

create_table_view body → 201400401500

GET

/tableviews/{id}

Get a table view

get_table_view 1 param → 200400404500

PUT

/tableviews/{id}

Update table view

update_table_view 1 param body → 200400404500

DELETE

/tableviews/{id}

Delete a table view

delete_table_view 1 param → 204400404500

Template 7

Templates are specially marked-up configurations that can be pushed to multiple devices, for instance during a large deployment of similarly configured devices. Each template can…

GET

/templates

List templates

list_templates 5 params → 200

POST

/templates

Create a template

create_template body → 200400

GET

/templates/{id}

Retrieve a template

get_template 1 param → 200404

PUT

/templates/{id}

Update a template

update_template 1 param body → 200400404

DELETE

/templates/{id}

Delete a template

delete_template 1 param → 204404

POST

/templates/{id}/download

Download a template

download_template 3 params body → 200400

POST

/templates/{id}/push

Push a template

push_template 1 param body → 204400

Token 5

Personal access tokens are used to authenticate requests to the API. Tokens are tied to the user that created them. All API operations undertaken via a personal access token are l…

GET

/tokens

List tokens

list_tokens 5 params → 200

POST

/tokens

Create a token

create_token body → 200400

GET

/tokens/{id}

Retrieve a token

get_token 1 param → 200404

PUT

/tokens/{id}

Update a token

update_token 1 param body → 200400404

DELETE

/tokens/{id}

Delete a token

delete_token 1 param → 204404

Transcript 2

Device command and backup transcripts can be retrieved here.

GET

/transcripts

List transcripts

list_transcripts 9 params → 200400401500

GET

/transcripts/{id}

Retrieve a transcript

get_transcript 1 param → 200400404500

User 8

Skylar Compliance supports three levels of user access: - Admin: Super User; has full control (can create/modify/delete devices and users, initiate backups/restores and change the…

GET

/users

List users

list_users 12 params → 200

POST

/users

Create a user

create_user body → 200400

POST

/users/broadcast

Broadcast user message

user_broadcast body → 204

GET

/users/{id}

Retrieve a user

get_user 1 param → 200404

PUT

/users/{id}

Update a user

update_user 1 param body → 200400404

DELETE

/users/{id}

Delete a user

delete_user 1 param → 204404

POST

/users/{id}/action

Log user's action

log_action 1 param → 200400401500

GET

/users/{id}/activationlink

Sends the activation link to the user by email

email_activation_link 1 param → 204

User/LDAP 4

For LDAP users to be able to login to Skylar Compliance, they need to be a member of a group and the group has to be added to Skylar Compliance (with domains and roles assigned).…

GET

/users/ldap/groups

List LDAP groups

list_ldap_groups 4 params → 200400500

POST

/users/ldap/groups

Create an LDAP group

create_ldap_group body → 200400500

PUT

/users/ldap/groups/{id}

Update an LDAP group

update_ldap_group 1 param body → 200400500

DELETE

/users/ldap/groups/{id}

Delete an LDAP group

delete_ldap_group 1 param → 204400500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs ScienceLogic publishes across the network.

ScienceLogic

AE Profile APIs.io

Skylar One GraphQL API

AE Profile APIs.io

Skylar One REST API

AE Profile APIs.io

ScienceLogic MCP Server

AE Profile APIs.io

#Compliance#Network Configuration Management#Backup

← Back to S APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=skylar-compliance-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/skylar-compliance-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Skylar Compliance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Skylar Compliance API

Metadata

Authentication & Security 3

Paths & Operations 314

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Skylar Compliance API

Metadata

Authentication & Security 3

Paths & Operations 314

Specification

Source

More from ScienceLogic 4

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key