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

...

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

Object type: @57u5n@

Example UUID: @zzzzz-57u5n-0123456789abcde@

h2. Resource

Each Log has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|object_uuid|string|The arvados object that is the subject of the log.||
|event_at|datetime|||
|event_type|string|A user-defined category or type for this event.|@LOGIN@|
|summary|text|||
|properties|hash|||

h3. 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. Methods

See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.

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

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.

See "common resource list method.":{{site.baseurl}}/api/methods.html#index

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||