Canary API Docs

# Google Documents and Sheets

These are a collection of endpoints that allow you to generate Google Document and Sheet Canarytokens

Endpoints
POST /api/v1/canarytoken/factorydoc/generate
POST /api/v1/canarytoken/factorydoc/sharehistory
POST /api/v1/canarytoken/registerdoc

TIP

These endpoints are recommended to be used via your Canary Console UI. The Canary Console UI will handle all the different flows and parameters needed, making your life a lot easier.

# Generate Factory for Google Document and Sheet Canarytoken

POST /api/v1/canarytoken/factorydoc/generate

Generates a Google Document or Google Sheet Canarytoken Factory.

Required Parameters

auth_token string
A valid auth token
memo string
A reminder of where you are placing this Canarytoken.
kind string
The type of Factory document you want to generate (googlesheets_factorydoc and googledocs_factorydoc are accepted)
share_with string
Email address of the person you are sharing the Google document or sheet Canarytoken with.

Optional Parameters

flock_id string
Defaults to: 'flock:default'
A valid flock_id (defaults to the Default Flock)

Response

A JSON structure with a result indicator and canarytoken information.

# Add share history to Google Document and Sheet Canarytoken Factory

POST /api/v1/canarytoken/factorydoc/sharehistory

Adds to the Google Doc or Sheet Canarytoken share history.

Required Parameters

autoreg_id string
The Canarytoken value attached to this Google Doc or Sheet.
parent string
The previous owner that shared this Google document or sheet with the current owner.

Optional Parameters

current boolean
Defaults to: false
Current owner of the Google document or sheet

Response

A JSON structure with a result indicator and the parent document and current document

# Auto register new Google Document and Sheet Canarytokens

POST /api/v1/canarytoken/registerdoc

Auto registers a new Google Document or Sheet to an existing Google Document or Sheet Factory.

Required Parameters

autoreg_id string
The Canarytoken value attached to this Google Doc or Sheet Factory
kind string
The type of Google document to register (allows autoreg-google-docs or autoreg-google-sheets)
email string
The email address of the new owner of the Google document or sheet.
doc_id string
The Google document or sheet id returned from Google when the document or sheet was created.
doc_name string
New Google document or sheet's name

Response

← Audit Trail →