Log Archive

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/log-archives

Summary

Resources	Methods
https://localhost:8443/api/rest/log-archives	GET Retrieves a list of log archives and selective individual log files. GET Retrieves a list of the specified log archive type. DELETE Rolls and deletes all archived logs on this node.
https://localhost:8443/api/rest/log-archives/roll-logs	POST Initiates the process to roll the logs.
https://localhost:8443/api/rest/log-archives/snapshot-logs/{server-name}	POST Initiates the process to take a snapshot of the active logs.
https://localhost:8443/api/rest/log-archives/{log-archive-identifier}	GET Retrieves the log file. DELETE Deletes the log archive.

Resources

https://localhost:8443/api/rest/log-archives

Methods

GET

Retrieves a list of log archives and selective individual log files.
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-log-archive-list+xml application/vnd.plcm.plcm-log-archive-list+json	Log archive information successfully retrieved
304		Log information has not changed since the last retrieval. Note: The API client must provide the "plcm-log-archive-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-log-archive-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to log archives on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, auditor.

GET

Retrieves a list of the specified log archive type.
Instead of always returning information on all archive files, this api call allows the user to specify the
log archive type and whether to include checksum information.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-log-archive-request+xml

application/vnd.plcm.plcm-log-archive-request+json

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-log-archive-list+xml application/vnd.plcm.plcm-log-archive-list+json	Log archive information successfully retrieved
304		Log information has not changed since the last retrieval. Note: The API client must provide the "plcm-log-archive-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-log-archive-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to log archives on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, auditor.

DELETE

Rolls and deletes all archived logs on this node.

Response

Status	Representation	Description
204		All logs successfully rolled and deleted
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. User roles required: administrator

https://localhost:8443/api/rest/log-archives/roll-logs

Methods

POST

Initiates the process to roll the logs. A resource URL to check the status
of the roll operation will be returned in the Location header.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-roll-logs-request+xml

application/vnd.plcm.plcm-roll-logs-request+json

Response

Status	Representation	Description
202		The roll operation was started successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, auditor.

https://localhost:8443/api/rest/log-archives/snapshot-logs/{server-name}

Template Parameters

Name	Type	Description
server-name	xs:string	The name of the physical server where the snapshot is taken.

Methods

POST

Initiates the process to take a snapshot of the active logs.
The logs are archived but not rolled in this operation. A resource URL to check
the status of the archive operation will be returned in the Location header.
[tags: DMA]

Request

Response

Status	Representation	Description
202		The archiving operation was started successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, auditor.

https://localhost:8443/api/rest/log-archives/{log-archive-identifier}

Template Parameters

Name	Type	Description
log-archive-identifier	xs:string	The unique identifier of the log file archive

Methods

GET

Retrieves the log file. This could be either an archived, which includes several logs, or
an individual log file.
[tags: DMA]

Response

Status	Representation	Description
200	application/gzip	Log archive successfully downloaded.
304		Log archive information has not changed since the last retrieval. Note: The API client must provide the "plcm-log-archive" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical single log archive retrieval in the "If-None-Match" header, then the HTTP response will contain the log archive representation in the message body. The "plcm-log-archive" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical domain and user name to ensure an equivalent ETag value. This also assumes no other client made changes to log archive on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator, auditor
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such log archive
429	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Too many requests. Maximum number of concurrent requests in progress. Try back later.

DELETE

Deletes the log archive.
[tags: DMA]

Response

Status	Representation	Description
204		Log archive successfully deleted
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: auditor
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only log archives that have been downloaded may be deleted.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such log archive.