REST Resources
/api/space/audit-log-management/archive-purge-audit-logs
The following operations are supported on this resource:
POST /archive-purge-audit-logs | Version 1 |
Archive / Purge audit log entries generated before time specified by "purge-time".
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /archive-purge-audit-logs?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
- Parameters:
Name Type URI Type Description Required 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
- Content-Type Headers:
application/vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-time-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-time-request+json;version=1;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<archive-purge-audit-logs-by-time-request>
<purge-time>Long</purge-time>
<purge-from-all-domains>Boolean</purge-from-all-domains>
<archive-before-purge>Boolean</archive-before-purge>
<remote-archive-info>
<user-name>String</user-name>
<password>String</password>
<remote-ip>String</remote-ip>
<archive-path>String</archive-path>
</remote-archive-info>
</archive-purge-audit-logs-by-time-request>
<task href="/api/space/job-management/jobs/688127">
<id>688127</id>
</task>
{
"archive-purge-audit-logs-by-time-request" : {
"purge-time" : "Long" ,
"purge-from-all-domains" : "Boolean" ,
"archive-before-purge" : "Boolean" ,
"remote-archive-info" : {
"user-name" : "String" ,
"password" : "String" ,
"remote-ip" : "String" ,
"archive-path" : "String"
}
}
}
{
"task":{
"@href":"/api/space/job-management/jobs/688127",
"id":688127
}
}
Access Control
The following capabilities are required to access this API: PurgeAuditLogs
POST /archive-purge-audit-logs | Version 1 |
Archive / Purge audit log entries older than days specified by "purge-days".
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /archive-purge-audit-logs?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
- Parameters:
Name Type URI Type Description Required 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
- Content-Type Headers:
application/vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-age-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.audit-log-management.archive-purge-audit-logs-by-age-request+json;version=1;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<archive-purge-audit-logs-by-age-request>
<purge-days>Long</purge-days>
<purge-from-all-domains>Boolean</purge-from-all-domains>
<archive-before-purge>Boolean</archive-before-purge>
<remote-archive-info>
<user-name>String</user-name>
<password>String</password>
<remote-ip>String</remote-ip>
<archive-path>String</archive-path>
</remote-archive-info>
</archive-purge-audit-logs-by-age-request>
<task href="/api/space/job-management/jobs/1081348">
<id>1081348</id>
</task>
{
"archive-purge-audit-logs-by-age-request" : {
"purge-days" : "Long" ,
"purge-from-all-domains" : "Boolean" ,
"archive-before-purge" : "Boolean" ,
"remote-archive-info" : {
"user-name" : "String" ,
"password" : "String" ,
"remote-ip" : "String" ,
"archive-path" : "String"
}
}
}
{
"task":{
"@href":"/api/space/job-management/jobs/1081348",
"id":1081348
}
}
Access Control
The following capabilities are required to access this API: PurgeAuditLogs