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

...

h1. logs

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


h2. create

Create a new Log.

Arguments:

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

h2. delete

Delete an existing Log.

Arguments:

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

h2. destroy

destroy logs

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string||path||

h2. get

Gets a Log's metadata by UUID.

Arguments:

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

h2. index

index logs

Arguments:

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

h2. list

List logs.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of logs to return.|query||
|order|string|Order in which to return matching logs.|query||
|pageToken|string|Page token.|query||
|q|string|Query string for searching logs.|query||
|where|object|Conditions for filtering logs.|query||

h2. show

show logs

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string||path||

h2. update

Update attributes of an existing Log.

Arguments:

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