@@ -33,3 +33,36 @@ for Windows and Mac includes Docker Composer. Linux users will need to install
3333[ Docker Engine] ( https://docs.docker.com/engine/install/ ) and
3434[ Docker Composer] ( https://docs.docker.com/compose/install/ ) manually until
3535Docker Desktop for Linux is available.
36+
37+ # JupiterOne as a Storage Endpoint
38+
39+ In addition to a local Neo4J storage endpoint, Starbase supports a remote
40+ JupiterOne storage endpoint, allowing you to run your integrations locally (or
41+ on-premise) and persist your integration data directly to a configured
42+ JupiterOne account.
43+
44+ You may specify multiple storage endpoints in the ` storage ` list, for example if
45+ you also wanted to persist data to a local Neo4J storage endpoint.
46+
47+ ## Configuring the JupiterOne Storage Endpoint
48+
49+ Add a configuration stanza like the following to your ` config.yaml ` :
50+
51+ ```
52+ storage:
53+ -
54+ engine: jupiterone
55+ config:
56+ apiKey: your-unique-api-key (may be either user or account key, needs graph write permission)
57+ accountId: your-j1-account-id
58+ ```
59+
60+ NOTE: if the canonical API URL for your account/region is not
61+ ` https://api.us.jupiterone.io ` , you will need to specify an additional storage
62+ configuration parameter, ` apiBaseUrl ` , with the HTTPS URL appropriate for the
63+ token and account you've provided.
64+
65+ See [ JupiterOne API] ( https://community.askj1.com/kb/articles/794-jupiterone-api )
66+ and
67+ [ Creating User and Account API Keys] ( https://community.askj1.com/kb/articles/785-creating-user-and-account-api-keys )
68+ docs for additional details.
0 commit comments