Skip to main content
JupiterOne
Betav0.1.0
55 actions · 1 auth method
SecurityObservabilityIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Requires a JupiterOne API key plus your Account ID. The key carries a fine-grained permission policy chosen when it is c…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

55 actions
Action
Description
List Alert Instances
List the active, inactive or dismissed alert instances produced by your JupiterOne alert rules.
Get Alert Rule Instance
Fetch a single alert rule (question rule) instance by its ID.
Create Inline Question Alert Rule
Create an alert rule whose J1QL query is defined inline on the rule itself.
Update Inline Question Alert Rule
Update an existing alert rule whose J1QL query is defined inline on the rule itself.
Create Referenced Question Alert Rule
Create an alert rule that evaluates an existing saved question from the question library.
Update Referenced Question Alert Rule
Update an existing alert rule that evaluates a saved question from the question library.
Delete Alert Rule Instance
Permanently delete an alert rule instance, whether it uses an inline or a referenced question.
Evaluate Alert Rule Instance
Trigger an on-demand evaluation of an alert rule outside its scheduled polling interval.
Get Rule Evaluation Results CSV
Export the included or exempted result set of a single rule evaluation as a CSV.
List Audit Events
Retrieve the audit log of user actions performed on the JupiterOne account.
Create Entity
Create a new entity (graph vertex) in JupiterOne with a key, type, class and optional properties.
Update Entity
Update the custom properties of an existing entity identified by its entity ID.
Delete Entity
Delete an existing entity by its entity ID, either as a soft delete or a hard delete.
Run J1QL Query
Run a J1QL query string against the account’s entity and relationship graph and return the matching rows.
Get Entity
Retrieve a single entity (vertex) and its properties by id or by a set of filters.
Get Entity Neighbors
Traverse the graph outward from an entity to a given depth and return the neighbouring vertices and edges.
Get Relationship
Retrieve a single relationship (edge) and its properties by id, label or a set of filters.
Get Entity Count
Count the entities matching a set of vertex filters.
Get Type Counts
Count entities broken down by entity type for the given entity classes.
Validate J1QL Queries
Validate the syntax of one or more J1QL query strings without executing them.
Get All Entity Counts
Get a single account-wide inventory summary of entity counts by type and class.
List IAM Groups
Retrieve all IAM groups in the account, with cursor pagination.
List Users In An IAM Group
Retrieve the members of a specific IAM group, with cursor pagination.
Create An IAM Group
Create a new IAM group, optionally with ABAC permissions and a query policy.
Update An IAM Group
Update an existing IAM group’s name, description, ABAC permissions or query policy.
Add A User To An IAM Group
Add a user to an IAM group by their account email address.
Remove A User From An IAM Group
Remove a user from an IAM group by their account email address.
Set A Permission On A Resource
Create or update a group’s create/read/update/delete permission on a dashboard, integration or rule.
Get Integration Instance
Retrieve a single JupiterOne integration instance (configuration) by its ID.
Update Integration Instance
Update the polling schedule of an existing JupiterOne integration instance.
Invoke Integration Instance
Trigger an immediate, ad-hoc run of a JupiterOne integration instance.
Get Integration Definition
Retrieve a single JupiterOne integration definition by its ID.
Find Integration Definition
Look up a JupiterOne integration definition by its integration type.
List Integration Jobs
List the integration job run history for a JupiterOne integration instance.
List Integration Definitions
List every integration definition available in the JupiterOne account.
List Questions
Search saved J1QL questions by free-text query.
Create Question
Create a saved J1QL question with one or more named queries.
Update Question
Update an existing saved J1QL question by id.
Delete Question
Permanently delete a saved J1QL question by id.
Evaluate Question
Run a saved J1QL question and return its computed answer.
Create Relationship
Create a graph-edge relationship between two existing entities.
Update Relationship
Update the endpoints and custom properties of an existing relationship by its relationship ID.
Delete Relationship
Delete a relationship by its relationship ID, either as a soft delete or a hard delete.
Check Rule Exemption Eligibility
Check whether the results of a specific rule evaluation can be exempted.
Create Rule Exemptions
Exempt one or more entities from a rule’s evaluation results so they stop counting and stop triggering its actions.
Revoke Rule Exemptions
Revoke existing exemptions on a rule by group ID, by entity IDs, or by both.
List Rule Exemptions
List the exemptions recorded against a specific alert rule, with cursor pagination.
Create Sync Job
Start a new JupiterOne synchronization job that entities and relationships can be uploaded into and finalized against.
Get Sync Job
Retrieve the current status and upload counters for a JupiterOne synchronization job.
Upload Sync Job Entities
Upload a batch of entities into an existing JupiterOne synchronization job.
Upload Sync Job Relationships
Upload a batch of relationships into an existing JupiterOne synchronization job.
Upload Sync Job Batch
Upload entities and relationships together into an existing JupiterOne synchronization job in a single request.
Finalize Sync Job
Finalize a JupiterOne synchronization job so its uploaded data is reconciled into the graph.
Create API Token
Create a new account-level JupiterOne API token scoped by a JSON permissions policy.
Revoke API Token
Revoke an existing account-level JupiterOne API token by its ID, permanently invalidating it.