2024.09

2024.03

Viya_35

2025.09

2025.03

2025.12

2026.01

2026.02

2026.03

The CAS REST API provides REST access to CAS functionality and server information, including CAS session management, running actions, and uploading data to the CAS server.

CAS REST

Add a new appender to the system, either a console appender or a file appender. Some parameters are specific to the file appender and, although marked as required, are not required for the console appender.

appenderName

The type of appender being added, either "file" or "console".

type

Immediately flushes output instead of buffering.

flush

When type=="file", causes the appender to append to existing content in the file instead of truncating it.

append

When type=="file", the path where the file will reside.

path

When type == "file", prefix used for filenames of log files. Helpful when using routing several groups of loggers to different appenders.

namePrefix

HTTP basic authentication. Use only with SSL enabled.

CAS OAuth2 authentication. OAuth scopes are only used for group memberships.

Add a new appender

Action Definition

Action Disposition

Action Metrics

Action Parameter

Action Result Value

Action Results

Action Results Metrics

Action Set

An action set group is a group of action sets that have been aggregated
into a set. The entire group can be loaded by calling loadActionSet with
the name of the action set group.


Action Set Group

Alias

API Result

Appender

CAS Administrator

A name/value pair that specifies a configuration option.

CAS Configuration Value

CAS Message

CAS Node CPU Time

The time properties will be omitted from the object if the CPU times cannot be
retrieved from the grid node. Existence only needs to be checked for one of the
CPU time fields: if one is omitted, all are omitted.


CAS Node CPU Time With Node Type

CAS Node Information

CAS Node Memory Metrics

CAS Node Metrics

CAS Node Process Metrics

CAS Notifications

CAS Process

CAS Resource

CAS Server Information

CAS Server State

CAS Server type. 'BackupController' and 'Backup' are synonyms. Compare for both values to determine if server is a backup controller.

CAS Server Type

Defines the information needed to access data from a particular data storage system/data provider.

Caslib - CAS Library

Changed Resources

CPU Information

CPU Metrics

CPU Time

Enumeration Value

Environment Variable

An identifier for the failure that occurred.

Error Code

Error Response

Log Entry

Logger

The level of messages that are output by a logger.

Logging Level

Memory Metrics

Process

Process Environment

Results Table

Results Table Column

Session Information

Session Owner

Session Summary

System Information

Thread

Top System Metrics

Name	Type	Required	Description
append	boolean	true	When type=="file", causes the appender to append to existing content in the file instead of truncating it.
flush	boolean	true	Immediately flushes output instead of buffering.
namePrefix	string	true	When type == "file", prefix used for filenames of log files. Helpful when using routing several groups of loggers to different appenders.
path	string	true	When type=="file", the path where the file will reside.
type	string	true	The type of appender being added, either "file" or "console". Allowed values: fileconsole

Name	Type	Required	Description
type	string	true	The type of appender being added, either "file" or "console". Allowed values: fileconsole
flush	boolean	true	Immediately flushes output instead of buffering.
append	boolean	true	When type=="file", causes the appender to append to existing content in the file instead of truncating it.
path	string	true	When type=="file", the path where the file will reside.
namePrefix	string	true	When type == "file", prefix used for filenames of log files. Helpful when using routing several groups of loggers to different appenders.

Status	Meaning	Description
201	Created	Created
400	Bad Request	Bad Request

Add a new appender

Request Samples

Response Samples

Path Parameters

Query Parameters

Request Body

Responses