service.apikey

The Synapse service.apikey tool can be used to add, list, or delete user API keys from a Synapse service.

Syntax

apikey is executed using python -m synapse.tools.service.apikey. The command usage is as follows:

python -m synapse.tools.service.apikey -h

usage: synapse.tools.service.apikey [-h] [--svcurl SVCURL] {add,list,del} ...

Add, list, or delete user API keys from a Synapse service.

positional arguments:
  {add,list,del}
    add            Add a user API key.
    list           List user API keys.
    del            Delete a user API key.

options:
  -h, --help       show this help message and exit
  --svcurl SVCURL  The telepath URL of the Synapse service.

Note

This tool was previously run using synapse.tools.apikey. It can still be run with that name.