> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# JupiterOne

> How to set up the JupiterOne connector, plus the actions that are available.

![JupiterOne](https://stackone-logos.com/api/jupiterone/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/jupiterone/changelog.md)

[55 actions](#actions) · 1 auth method

Security
Observability
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/jupiterone/guides/connector-profile/api-key.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/jupiterone/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

55 actions

ActionDescription

List Alert Instances`jupiterone_list_alert_instances`

List the active, inactive or dismissed alert instances produced by your JupiterOne alert rules.

Get Alert Rule Instance`jupiterone_get_rule_instance`

Fetch a single alert rule (question rule) instance by its ID.

Create Inline Question Alert Rule`jupiterone_create_inline_rule`

Create an alert rule whose J1QL query is defined inline on the rule itself.

Update Inline Question Alert Rule`jupiterone_update_inline_rule`

Update an existing alert rule whose J1QL query is defined inline on the rule itself.

Create Referenced Question Alert Rule`jupiterone_create_referenced_rule`

Create an alert rule that evaluates an existing saved question from the question library.

Update Referenced Question Alert Rule`jupiterone_update_referenced_rule`

Update an existing alert rule that evaluates a saved question from the question library.

Delete Alert Rule Instance`jupiterone_delete_rule_instance`

Permanently delete an alert rule instance, whether it uses an inline or a referenced question.

Evaluate Alert Rule Instance`jupiterone_evaluate_rule_instance`

Trigger an on-demand evaluation of an alert rule outside its scheduled polling interval.

Get Rule Evaluation Results CSV`jupiterone_get_rule_results_csv`

Export the included or exempted result set of a single rule evaluation as a CSV.

List Audit Events`jupiterone_list_audit_events`

Retrieve the audit log of user actions performed on the JupiterOne account.

Create Entity`jupiterone_create_entity`

Create a new entity (graph vertex) in JupiterOne with a key, type, class and optional properties.

Update Entity`jupiterone_update_entity`

Update the custom properties of an existing entity identified by its entity ID.

Delete Entity`jupiterone_delete_entity`

Delete an existing entity by its entity ID, either as a soft delete or a hard delete.

Run J1QL Query`jupiterone_run_j1ql_query`

Run a J1QL query string against the account's entity and relationship graph and return the matching rows.

Get Entity`jupiterone_get_entity`

Retrieve a single entity (vertex) and its properties by id or by a set of filters.

Get Entity Neighbors`jupiterone_get_entity_neighbors`

Traverse the graph outward from an entity to a given depth and return the neighbouring vertices and edges.

Get Relationship`jupiterone_get_relationship`

Retrieve a single relationship (edge) and its properties by id, label or a set of filters.

Get Entity Count`jupiterone_get_entity_count`

Count the entities matching a set of vertex filters.

Get Type Counts`jupiterone_get_type_counts`

Count entities broken down by entity type for the given entity classes.

Validate J1QL Queries`jupiterone_validate_j1ql`

Validate the syntax of one or more J1QL query strings without executing them.

Get All Entity Counts`jupiterone_get_all_entity_counts`

Get a single account-wide inventory summary of entity counts by type and class.

List IAM Groups`jupiterone_list_iam_groups`

Retrieve all IAM groups in the account, with cursor pagination.

List Users In An IAM Group`jupiterone_list_iam_group_users`

Retrieve the members of a specific IAM group, with cursor pagination.

Create An IAM Group`jupiterone_create_iam_group`

Create a new IAM group, optionally with ABAC permissions and a query policy.

Update An IAM Group`jupiterone_update_iam_group`

Update an existing IAM group's name, description, ABAC permissions or query policy.

Add A User To An IAM Group`jupiterone_add_user_to_iam_group_by_email`

Add a user to an IAM group by their account email address.

Remove A User From An IAM Group`jupiterone_remove_user_from_iam_group_by_email`

Remove a user from an IAM group by their account email address.

Set A Permission On A Resource`jupiterone_set_resource_permission`

Create or update a group's create/read/update/delete permission on a dashboard, integration or rule.

Get Integration Instance`jupiterone_get_integration_instance`

Retrieve a single JupiterOne integration instance (configuration) by its ID.

Update Integration Instance`jupiterone_update_integration_instance`

Update the polling schedule of an existing JupiterOne integration instance.

Invoke Integration Instance`jupiterone_invoke_integration_instance`

Trigger an immediate, ad-hoc run of a JupiterOne integration instance.

Get Integration Definition`jupiterone_get_integration_definition`

Retrieve a single JupiterOne integration definition by its ID.

Find Integration Definition`jupiterone_find_integration_definition`

Look up a JupiterOne integration definition by its integration type.

List Integration Jobs`jupiterone_list_integration_jobs`

List the integration job run history for a JupiterOne integration instance.

List Integration Definitions`jupiterone_list_integration_definitions`

List every integration definition available in the JupiterOne account.

List Questions`jupiterone_list_questions`

Search saved J1QL questions by free-text query.

Create Question`jupiterone_create_question`

Create a saved J1QL question with one or more named queries.

Update Question`jupiterone_update_question`

Update an existing saved J1QL question by id.

Delete Question`jupiterone_delete_question`

Permanently delete a saved J1QL question by id.

Evaluate Question`jupiterone_evaluate_question`

Run a saved J1QL question and return its computed answer.

Create Relationship`jupiterone_create_relationship`

Create a graph-edge relationship between two existing entities.

Update Relationship`jupiterone_update_relationship`

Update the endpoints and custom properties of an existing relationship by its relationship ID.

Delete Relationship`jupiterone_delete_relationship`

Delete a relationship by its relationship ID, either as a soft delete or a hard delete.

Check Rule Exemption Eligibility`jupiterone_get_rule_exemption_eligibility`

Check whether the results of a specific rule evaluation can be exempted.

Create Rule Exemptions`jupiterone_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`jupiterone_revoke_rule_exemptions`

Revoke existing exemptions on a rule by group ID, by entity IDs, or by both.

List Rule Exemptions`jupiterone_list_rule_exemptions`

List the exemptions recorded against a specific alert rule, with cursor pagination.

Create Sync Job`jupiterone_create_sync_job`

Start a new JupiterOne synchronization job that entities and relationships can be uploaded into and finalized against.

Get Sync Job`jupiterone_get_sync_job`

Retrieve the current status and upload counters for a JupiterOne synchronization job.

Upload Sync Job Entities`jupiterone_upload_sync_entities`

Upload a batch of entities into an existing JupiterOne synchronization job.

Upload Sync Job Relationships`jupiterone_upload_sync_relationships`

Upload a batch of relationships into an existing JupiterOne synchronization job.

Upload Sync Job Batch`jupiterone_upload_sync_bulk`

Upload entities and relationships together into an existing JupiterOne synchronization job in a single request.

Finalize Sync Job`jupiterone_finalize_sync_job`

Finalize a JupiterOne synchronization job so its uploaded data is reconciled into the graph.

Create API Token`jupiterone_create_api_token`

Create a new account-level JupiterOne API token scoped by a JSON permissions policy.

Revoke API Token`jupiterone_revoke_api_token`

Revoke an existing account-level JupiterOne API token by its ID, permanently invalidating it.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.