Replace a Service

put

https://clearpass-hostname/api/config/service/{services_id}

Replace a Service

Path Params

services_id

string

required

Numeric ID of the service

Body Params

name

string

required

Name of the Service

template

string

enum

required

Template of the Service

enabled

boolean

Is Service enabled?

order_no

int64

Order number of the Service

description

string

Description of the Service

monitor_mode

boolean

Enable to monitor network access without enforcement

rules_match_type

string

enum

Matches ANY/ALL of the rule conditions

Allowed:

rules_conditions

array of objects

List of service rules conditions

rules_conditions

auth_methods

array of strings

List of Authentication Method Names

auth_methods

auth_sources

array of strings

List of Authentication Source Names

auth_sources

strip_username

boolean

Enable to specify a comma-separated list of rules to strip username prefixes or suffixes

strip_username_csv

string

Strip Username Rule

service_cert_cn

string

Subject DN of Service Certificate

service_cert_expiry_date

string

Expiry Date of Service Certificate (Date Format - MMM dd, yyyy HH:mm:ss Z)

role_mapping_policy

string

Role Mapping Policy Name

enf_policy

string

required

Enforcement Policy Name

use_cached_policy_results

boolean

Enable to use cached Roles and Posture attributes from previous sessions

authz_sources

array of strings

List of Additional authorization sources from which to fetch role-mapping attributes

authz_sources

posture_enabled

boolean

Enable Posture Compliance

posture_policies

array of strings

List of Posture Policy Names

posture_policies

default_posture_token

string

enum

Default Posture Token

Allowed:

remediate_end_hosts

boolean

Enable auto-remediation of non-compliant end-hosts

remediation_url

string

Remediation URL

audit_enabled

boolean

Enable Audit End-hosts

audit_server

string

Audit Server Name

audit_trigger_condition

string

enum

Audit Trigger Conditions

Allowed:

audit_mac_auth_client_type

string

enum

Client Type For MAC authentication request Audit Trigger Condition

Allowed:

action_after_audit

string

enum

Action after audit

Allowed:

audit_coa_acton

string

RADIUS CoA Action to be triggered after audit

profiler_enabled

boolean

Enable Profile Endpoints

profiler_endpoint_classification

array of strings

List of Endpoint classification(s) after which an action must be triggered

profiler_endpoint_classification

profiler_coa_action

string

RADIUS CoA Action to be triggered by Profiler

acct_proxy_enabled

boolean

Enable Accounting Proxy Targets

acct_proxy_targets

array of strings

List Accounting Proxy Target names

acct_proxy_targets

acct_proxy_attrs_to_delete

array of objects

RADIUS attributes to be deleted for Accounting proxy

acct_proxy_attrs_to_delete

acct_proxy_attrs_to_add

array of objects

RADIUS attributes to be added for Accounting proxy

acct_proxy_attrs_to_add

radius_proxy_scheme

string

enum

Proxying Scheme for RADIUS Proxy Service Type

Allowed:

radius_proxy_targets

array of strings

List of Proxy Targets for RADIUS Proxy Service Type

radius_proxy_targets

radius_proxy_attrs_to_delete

array of objects

RADIUS attributes to be removed from remote server (proxy target) reply

radius_proxy_attrs_to_delete

radius_proxy_enable_for_acct

boolean

Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type)

Responses

Language

Response

Choose an example:

application/json

200OK

204No Content

304Not Modified

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

415Unsupported Media Type

422Unprocessable Entity