REST Resources

/api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{id}

The following operations are supported on this resource:

  • GET - Get Forwarding Criteria By ID
  • PUT - Edit Forwarding Criterion By ID
  • DELETE - Delete Forwarding Criterion
GET /audit-log-forwarding/forwarding-criteria/{id} Version 2

Get Forwarding Criteria By ID.

Sample Usage

GET /audit-log-forwarding/forwarding-criteria/{id}


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path ID Y
  • Sample Output XML:
    <forwarding-criterion
         href="/api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{id}" uri="/api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{id}">
         <id>Integer</id>
         <name>String</name>
         <description>String</description>
         <syslog-server>
               <host-address>String</host-address>
               <port>Integer</port>
               <protocol>UDP</protocol>
         </syslog-server>
         <enabled>Boolean</enabled>
         <filters total="Integer">
               <filter>
                   <attribute>String</attribute>
                   <operator>EQUALS</operator>
                   <value>String</value>
               </filter>
         </filters>
    </forwarding-criterion>

  • Sample Output JSON:
    {
       "forwarding-criterion" : {
         "@href" :
         "/api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{id}"
         ,
         "@uri" :
         "/api/space/audit-log-management/audit-log-forwarding/forwarding-criteria/{id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "description" : "String" ,
         "syslog-server" : {
           "host-address" : "String" ,
           "port" : "Integer" ,
           "protocol" : "UDP"
         } ,
         "enabled" : "Boolean" ,
         "filters" : {
           "@total" : "Integer" ,
           "filter" : {
             "attribute" : "String" ,
             "operator" : "EQUALS" ,
             "value" : "String"
           }
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ManageAuditLogForwarding

    PUT /audit-log-forwarding/forwarding-criteria/{id} Version 2

    Edit Forwarding Criterion By ID.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    PUT /audit-log-forwarding/forwarding-criteria/{id}?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <forwarding-criterion>
         <name>String</name>
         <description>String</description>
         <syslog-server>
               <host-address>String</host-address>
               <port>Integer</port>
               <protocol>UDP</protocol>
         </syslog-server>
         <enabled>Boolean</enabled>
         <filters total="Integer">
               <filter>
                   <attribute>String</attribute>
                   <operator>EQUALS</operator>
                   <value>String</value>
               </filter>
         </filters>
    </forwarding-criterion>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/id">
      <id>Integer</id>
    </task>

  • Sample Input JSON:
    {
       "forwarding-criterion" : {
         "name" : "String" ,
         "description" : "String" ,
         "syslog-server" : {
           "host-address" : "String" ,
           "port" : "Integer" ,
           "protocol" : "UDP"
         } ,
         "enabled" : "Boolean" ,
         "filters" : {
           "@total" : "Integer" ,
           "filter" : {
             "attribute" : "String" ,
             "operator" : "EQUALS" ,
             "value" : "String"
           }
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/id",
        "id":Integer
      }
    }

    • Access Control

    The following capabilities are required to access this API: modifyForwardCriteria

    DELETE /audit-log-forwarding/forwarding-criteria/{id} Version 2

    Delete Forwarding Criterion.

    Sample Usage

    DELETE /audit-log-forwarding/forwarding-criteria/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y

    Access Control

    The following capabilities are required to access this API: deleteForwardCriteria