---
layout: default
navsection: api
navmenu: API Methods
title: "logs"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@

UUID type: @57u5n@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Creation

Any user may create Log entries for any event they find useful. User-generated Logs have no intrinsic meaning to other users or to the Arvados system itself; it is up to each user to choose appropriate log event types and summaries for their project.

h3. System Logs

Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.

h2. Resource

Each Log has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|object_uuid|string|||
|event_at|datetime|||
|event_type|string|A user-defined category or type for this event.|@LOGIN@|
|summary|text|||
|properties|hash|||

h2. Methods

h3. create

Create a new log entry.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|log|object||query||

h3. delete

Delete an existing log entry. This method can only be used by privileged (system administrator) users.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||

h3. get

Retrieve a log entry.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||

h3. list

List log entries.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of log entries to return.|query||
|order|string|Order in which to return matching log entries.|query||
|filters|array|Conditions for filtering log entries.|query||

h3. update

Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
|log|object||query||