GraphQL API Reference

Welcome to the Horizon3.ai GraphQL API reference! This reference includes the complete set of GraphQL types, queries, mutations, and their parameters available to users of Horizon3.ai products.

First, learn how to authenticate with the API.

Horizon3.ai API support: support@horizon3.ai

The examples below show the format of the GraphQL query. A GraphQL query is sent to a GraphQL server using an HTTP POST request, for example:

curl -s -S -k \
    -X POST / \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer " \
    -d @- <<HERE 
{
    "query": "
        query action_logs_count(: OpInput!) {
            action_logs_count(input: )
        }
    ",
    "variables": {
        "input": {
            "op_id": "xxx"
        }
    }
}
HERE

API Endpoints

https://api.horizon3ai.com/v1/graphql

Headers

Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

`action_logs_count`

Description

Number of action logs for a given pentest.

Response

Returns an Int!

Arguments

Name	Description
`input` - `OpInput!`	Pentest to get action logs for.
`page_input` - `PageInput`	Pagination of action logs.

Example

Query

query action_logs_count(
  $input: OpInput!,
  $page_input: PageInput
) {
  action_logs_count(
    input: $input,
    page_input: $page_input
  )
}

Variables

{
  "input": OpInput,
  "page_input": PageInput
}

Response

{"data": {"action_logs_count": 987}}

Queries

`action_logs_page`

Description

List of action logs for a given pentest.

Response

Returns an ActionLogsPage!

Arguments

Name	Description
`input` - `OpInput!`	Pentest to get action logs for.
`page_input` - `PageInput`	Pagination of action logs.

Example

Query

query action_logs_page(
  $input: OpInput!,
  $page_input: PageInput
) {
  action_logs_page(
    input: $input,
    page_input: $page_input
  ) {
    page_info {
      ...PageInfoFragment
    }
    action_logs {
      ...ActionLogFragment
    }
  }
}

Variables

{
  "input": OpInput,
  "page_input": PageInput
}

Response

{
  "data": {
    "action_logs_page": {
      "page_info": PageInfo,
      "action_logs": [ActionLog]
    }
  }
}

Queries

`asset_group`

Description

Fetch a specific asset group from this account.

Response

Returns an AssetGroup

Arguments

Name	Description
`uuid` - `String!`

Example

Query

query asset_group($uuid: String!) {
  asset_group(uuid: $uuid) {
    uuid
    name
    op_template_uuid
    op_template {
      ...OpTemplateFragment
    }
    user_account_uuid
    user_account_name
    client_account_uuid
    client_account_company_name
    last_ead_etl_completed_at
    created_at
    updated_at
    assets_count
  }
}

Variables

{"uuid": "xyz789"}

Response

{
  "data": {
    "asset_group": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "name": "xyz789",
      "op_template_uuid": "12341234-1234-1234-1234-123412341234",
      "op_template": OpTemplate,
      "user_account_uuid": "12341234-1234-1234-1234-123412341234",
      "user_account_name": "xyz789",
      "client_account_uuid": "12341234-1234-1234-1234-123412341234",
      "client_account_company_name": "abc123",
      "last_ead_etl_completed_at": "2021-07-22T05:02:40.294996",
      "created_at": "2021-07-22T05:02:40.294996",
      "updated_at": "2021-07-22T05:02:40.294996",
      "assets_count": 123
    }
  }
}

Queries

`asset_groups_count`

Description

The number of asset groups in this account.

Response

Returns an Int!

Arguments

Name	Description
`page_input` - `PageInput`

Example

Query

query asset_groups_count($page_input: PageInput) {
  asset_groups_count(page_input: $page_input)
}

Variables

{"page_input": PageInput}

Response

{"data": {"asset_groups_count": 987}}

Queries

`asset_groups_page`

Description

Paginated list of asset groups in this account.

Response

Returns an AssetGroupsPage!

Arguments

Name	Description
`page_input` - `PageInput`

Example

Query

query asset_groups_page($page_input: PageInput) {
  asset_groups_page(page_input: $page_input) {
    page_info {
      ...PageInfoFragment
    }
    asset_groups {
      ...AssetGroupFragment
    }
  }
}

Variables

{"page_input": PageInput}

Response

{
  "data": {
    "asset_groups_page": {
      "page_info": PageInfo,
      "asset_groups": [AssetGroup]
    }
  }
}

Queries

`client_accounts_count`

Description

Number of client accounts accessible by the current user.

Response

Returns an Int!

Arguments

Name	Description
`page_input` - `PageInput`

Example

Query

query client_accounts_count($page_input: PageInput) {
  client_accounts_count(page_input: $page_input)
}

Variables

{"page_input": PageInput}

Response

{"data": {"client_accounts_count": 123}}

Queries

`client_accounts_page`

Description

Client accounts accessible by the current user.

Response

Returns a ClientAccountsPage!

Arguments

Name	Description
`page_input` - `PageInput`

Example

Query

query client_accounts_page($page_input: PageInput) {
  client_accounts_page(page_input: $page_input) {
    page_info {
      ...PageInfoFragment
    }
    client_accounts {
      ...ClientAccountFragment
    }
  }
}

Variables

{"page_input": PageInput}

Response

{
  "data": {
    "client_accounts_page": {
      "page_info": PageInfo,
      "client_accounts": [ClientAccount]
    }
  }
}

Queries

`hello`

Description

Hello world example.

Response

Returns a String!

Example

Query

query hello {
  hello
}

Response

{"data": {"hello": "abc123"}}

Queries

`hosts_csv`

Description

List of hosts found during a pentest. Returned as an array of comma-separated values, with each element in the array representing a row. Each element in array represents a single host, with the first element containing the column names.

Response

Returns [HostCSV]

Arguments

Name	Description
`input` - `OpInput!`	Pentest to get hosts data for.

Example

Query

query hosts_csv($input: OpInput!) {
  hosts_csv(input: $input)
}

Variables

{"input": OpInput}

Response

{"data": {"hosts_csv": [HostCSV]}}

Queries

`hosts_csv_url`

Description

List of hosts found during a pentest. Returns a presigned URL to the CSV file. The presigned URL expires after a short time. The CSV format is documented under HostCSV.

Response

Returns a String

Arguments

Name	Description
`input` - `OpInput!`

Example

Query

query hosts_csv_url($input: OpInput!) {
  hosts_csv_url(input: $input)
}

Variables

{"input": OpInput}

Response

{"data": {"hosts_csv_url": "xyz789"}}

Queries

`op`

Description

Get pentest data.

Response

Returns an Op

Arguments

Name	Description
`op_id` - `String!`	ID of pentest.

Example

Query

query op($op_id: String!) {
  op(op_id: $op_id) {
    op_id
    op_type
    op_state
    op_name
    scheduled_timestamp_iso
    scheduled_at
    scheduled_at_date
    completed_timestamp_iso
    launched_timestamp_iso
    confirmed_credentials_count
    weaknesses_count
    in_scope_hosts_count
    feature_flags {
      ...FeatureFlagFragment
    }
    nodezero_script_url
    duration_hms
    op_template_name
    impact_paths_count
  }
}

Variables

{"op_id": "xyz789"}

Response

{
  "data": {
    "op": {
      "op_id": "12341234-1234-1234-1234-123412341234",
      "op_type": "NodeZero",
      "op_state": "running",
      "op_name": "your op name",
      "scheduled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "scheduled_at": "2021-07-22T05:02:40.294996",
      "scheduled_at_date": "2022-08-06T19:43:07.150Z",
      "completed_timestamp_iso": "2021-07-22T05:02:40.294996",
      "launched_timestamp_iso": "2021-07-22T05:02:40.294996",
      "confirmed_credentials_count": 987,
      "weaknesses_count": 987,
      "in_scope_hosts_count": 987,
      "feature_flags": [FeatureFlag],
      "nodezero_script_url": "https://example.com/example",
      "duration_hms": "22:05:21",
      "op_template_name": "xyz789",
      "impact_paths_count": 987
    }
  }
}

Queries

`op_tabs_page`

Description

Get a list of pentests for client accounts accessible by the current user.

Response

Returns an OpTabsPage!

Arguments

Name	Description
`page_input` - `PageInput`	Pagination of pentests.

Example

Query

query op_tabs_page($page_input: PageInput) {
  op_tabs_page(page_input: $page_input) {
    page_info {
      ...PageInfoFragment
    }
    op_tabs {
      ...OpTabFragment
    }
  }
}

Variables

{"page_input": PageInput}

Response

{
  "data": {
    "op_tabs_page": {
      "page_info": PageInfo,
      "op_tabs": [OpTab]
    }
  }
}

Queries

`op_template`

Description

Get an op template.

Response

Returns an OpTemplate

Arguments

Name	Description
`op_template_uuid` - `String!`	The uuid of the op template

Example

Query

query op_template($op_template_uuid: String!) {
  op_template(op_template_uuid: $op_template_uuid) {
    uuid
    user_account_uuid
    client_account_uuid
    op_template_name
    op_type
    schedule_op_form {
      ...ScheduleOpFormFragment
    }
    row_created_at
    row_updated_at
  }
}

Variables

{"op_template_uuid": "xyz789"}

Response

{
  "data": {
    "op_template": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "user_account_uuid": "12341234-1234-1234-1234-123412341234",
      "client_account_uuid": "12341234-1234-1234-1234-123412341234",
      "op_template_name": "xyz789",
      "op_type": "NodeZero",
      "schedule_op_form": ScheduleOpForm,
      "row_created_at": "2021-07-22T05:02:40.294996",
      "row_updated_at": "2021-07-22T05:02:40.294996"
    }
  }
}

Queries

`op_templates`

Description

List of op templates, of a specified op type, for the current client account. Includes default templates provided by Horizon3.ai.

Response

Returns [OpTemplate]

Arguments

Name	Description
`op_type` - `String`	Optional. Must be either "NodeZero" (for internal pentests) or "ExternalAttack" (for external pentests). Defaults to "NodeZero".

Example

Query

query op_templates($op_type: String) {
  op_templates(op_type: $op_type) {
    uuid
    user_account_uuid
    client_account_uuid
    op_template_name
    op_type
    schedule_op_form {
      ...ScheduleOpFormFragment
    }
    row_created_at
    row_updated_at
  }
}

Variables

{"op_type": "abc123"}

Response

{
  "data": {
    "op_templates": [
      {
        "uuid": "12341234-1234-1234-1234-123412341234",
        "user_account_uuid": "12341234-1234-1234-1234-123412341234",
        "client_account_uuid": "12341234-1234-1234-1234-123412341234",
        "op_template_name": "xyz789",
        "op_type": "NodeZero",
        "schedule_op_form": ScheduleOpForm,
        "row_created_at": "2021-07-22T05:02:40.294996",
        "row_updated_at": "2021-07-22T05:02:40.294996"
      }
    ]
  }
}

Queries

`pentest`

Description

Get pentest data.

Response

Returns a Pentest

Arguments

Name	Description
`op_id` - `String!`	ID of pentest.

Example

Query

query pentest($op_id: String!) {
  pentest(op_id: $op_id) {
    op_id
    op_type
    name
    state
    user_name
    client_name
    min_scope
    max_scope
    exclude_scope
    git_accounts {
      ...GitAccountFragment
    }
    aws_account_ids
    feature_flags {
      ...FeatureFlagFragment
    }
    scheduled_at
    launched_at
    completed_at
    canceled_at
    etl_completed_at
    duration_s
    impacts_count
    impact_paths_count
    weakness_types_count
    weaknesses_count
    hosts_count
    out_of_scope_hosts_count
    external_domains_count
    services_count
    credentials_count
    users_count
    cred_access_count
    data_stores_count
    websites_count
    data_resources_count
    nodezero_script_url
    nodezero_ip
  }
}

Variables

{"op_id": "xyz789"}

Response

{
  "data": {
    "pentest": {
      "op_id": "12341234-1234-1234-1234-123412341234",
      "op_type": "NodeZero",
      "name": "abc123",
      "state": "done",
      "user_name": "abc123",
      "client_name": "abc123",
      "min_scope": ["xyz789"],
      "max_scope": ["abc123"],
      "exclude_scope": ["abc123"],
      "git_accounts": [GitAccount],
      "aws_account_ids": [AWSAccountId],
      "feature_flags": [FeatureFlag],
      "scheduled_at": "2021-07-22T05:02:40.294996",
      "launched_at": "2021-07-22T05:02:40.294996",
      "completed_at": "2021-07-22T05:02:40.294996",
      "canceled_at": "2021-07-22T05:02:40.294996",
      "etl_completed_at": "2021-07-22T05:02:40.294996",
      "duration_s": 123,
      "impacts_count": 123,
      "impact_paths_count": 123,
      "weakness_types_count": 987,
      "weaknesses_count": 987,
      "hosts_count": 123,
      "out_of_scope_hosts_count": 123,
      "external_domains_count": 987,
      "services_count": 987,
      "credentials_count": 987,
      "users_count": 987,
      "cred_access_count": 123,
      "data_stores_count": 987,
      "websites_count": 123,
      "data_resources_count": 987,
      "nodezero_script_url": "https://example.com/example",
      "nodezero_ip": "123.45.67.89"
    }
  }
}

Queries

`pentest_reports_zip_url`

Description

Returns a URL to a zip file containing all CSVs and PDFs for the given op_id.

The CSVs along with their schema types are listed below:

certificates.csv: CertificateCSV
credentials.csv: CredentialCSV
database_repos.csv: DatabaseRepoCSV
docker_registries.csv: DockerRegistryCSV
external_domains.csv: ExternalDomainCSV
file_shares.csv: FileShareCSV
git_repos.csv: GitRepoCSV
hosts.csv: HostCSV
s3_buckets.csv: S3BucketCSV
sensitive_files.csv: SensitiveFileCSV
services.csv: ServiceCSV
users.csv: UserCSV
weaknesses.csv: WeaknessCSV
websites.csv: WebShareCSV

Note: for pentests prior to Sep 2022, the zip file is generated "lazily"; ie. on demand, when the user first request it. The first request will receive a response saying the zip file is being generated. An email will be sent to the requesting user with a link to the zip file when it is ready. Subsequent requests will download the already-built zip file.

Response

Returns a String

Arguments

Name	Description
`input` - `OpInput!`

Example

Query

query pentest_reports_zip_url($input: OpInput!) {
  pentest_reports_zip_url(input: $input)
}

Variables

{"input": OpInput}

Response

{
  "data": {
    "pentest_reports_zip_url": "abc123"
  }
}

Queries

`pentests_count`

Description

Counts the number of pentests in the current client account, after applying any filters in page_input. By default archived pentests are excluded.

Response

Returns an Int!

Arguments

Name	Description
`page_input` - `PageInput`	Pagination of pentests.

Example

Query

query pentests_count($page_input: PageInput) {
  pentests_count(page_input: $page_input)
}

Variables

{"page_input": PageInput}

Response

{"data": {"pentests_count": 123}}

Queries

`pentests_page`

Description

Paginated list of pentests in the current client account. By default archived pentests are excluded.

Response

Returns a PentestsPage!

Arguments

Name	Description
`page_input` - `PageInput`	Pagination of pentests.

Example

Query

query pentests_page($page_input: PageInput) {
  pentests_page(page_input: $page_input) {
    page_info {
      ...PageInfoFragment
    }
    pentests {
      ...PentestFragment
    }
  }
}

Variables

{"page_input": PageInput}

Response

{
  "data": {
    "pentests_page": {
      "page_info": PageInfo,
      "pentests": [Pentest]
    }
  }
}

Queries

`session_user_account`

Description

Current user account.

Response

Returns a UserAccount

Example

Query

query session_user_account {
  session_user_account {
    uuid
    email
    name
    user_role_id
    sign_in_type
    last_signed_in_at
  }
}

Response

{
  "data": {
    "session_user_account": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "email": "john.smith@example.com",
      "name": "John Smith",
      "user_role_id": "USER",
      "sign_in_type": "BASIC",
      "last_signed_in_at": "2021-07-22T05:02:40.294996"
    }
  }
}

Queries

`user_accounts`

Description

List of user accounts with access to the current client account.

Response

Returns [UserAccount]!

Example

Query

query user_accounts {
  user_accounts {
    uuid
    email
    name
    user_role_id
    sign_in_type
    last_signed_in_at
  }
}

Response

{
  "data": {
    "user_accounts": [
      {
        "uuid": "12341234-1234-1234-1234-123412341234",
        "email": "john.smith@example.com",
        "name": "John Smith",
        "user_role_id": "USER",
        "sign_in_type": "BASIC",
        "last_signed_in_at": "2021-07-22T05:02:40.294996"
      }
    ]
  }
}

Queries

`weaknesses_csv`

Description

List of weaknesses and affected assets found during a pentest. Returned as an array of comma-separated values, with each element in the array representing a row. Each element in array represents a single weakness, with the first element containing the column names.

Response

Returns [WeaknessCSV]

Arguments

Name	Description
`input` - `OpInput!`	Pentest to get weakness data for.

Example

Query

query weaknesses_csv($input: OpInput!) {
  weaknesses_csv(input: $input)
}

Variables

{"input": OpInput}

Response

{"data": {"weaknesses_csv": [WeaknessCSV]}}

Queries

`weaknesses_csv_url`

Description

List of weaknesses and affected assets found during a pentest. Returns a presigned URL to the CSV file. The presigned URL expires after a short time. The CSV format is documented under WeaknessCSV.

Response

Returns a String

Arguments

Name	Description
`input` - `OpInput!`

Example

Query

query weaknesses_csv_url($input: OpInput!) {
  weaknesses_csv_url(input: $input)
}

Variables

{"input": OpInput}

Response

{"data": {"weaknesses_csv_url": "abc123"}}

Mutations

`add_domains_to_asset_group`

Description

Update an asset group with additional domains.

Response

Returns an AssetGroupOutput!

Arguments

Name	Description
`asset_group_uuid` - `String!`	ID of asset group to update.
`domains` - `[StringNotEmpty]!`	List of domains to add to the asset group's scope.

Example

Query

mutation add_domains_to_asset_group(
  $asset_group_uuid: String!,
  $domains: [StringNotEmpty]!
) {
  add_domains_to_asset_group(
    asset_group_uuid: $asset_group_uuid,
    domains: $domains
  ) {
    asset_group {
      ...AssetGroupFragment
    }
  }
}

Variables

{
  "asset_group_uuid": "abc123",
  "domains": [StringNotEmpty]
}

Response

{
  "data": {
    "add_domains_to_asset_group": {
      "asset_group": AssetGroup
    }
  }
}

Mutations

`cancel_op`

Description

Cancel a pentest, if its current state allows it.

Response

Returns an OpTab!

Arguments

Name	Description
`op_id` - `String!`

Example

Query

mutation cancel_op($op_id: String!) {
  cancel_op(op_id: $op_id) {
    uuid
    op_id
    op_state
    op_name
    scheduled_timestamp
    scheduled_at
    scheduled_at_date
    scheduled_timestamp_iso
    create_timestamp
    create_timestamp_iso
    launched_timestamp
    launched_timestamp_iso
    completed_timestamp
    completed_timestamp_iso
    canceled_timestamp
    canceled_timestamp_iso
    duration_hms
    op_type
    weaknesses_count
    host_tabs_count
    credentials_count
    proven_credentials_count
    confirmed_credentials_count
    unproven_credentials_count
    feature_flags {
      ...FeatureFlagFragment
    }
    impacts_headline_count
    impact_paths_count
    nodezero_script_url
    nodezero_ip
    etl_completed_at
    start_paused
    minimum_run_time
    maximum_run_time
    paused_at
    paused_by_user_account_uuid
    paused_by_user_account {
      ...UserAccountFragment
    }
    op_template_name
    excluded_ips {
      ...ExcludedIPFragment
    }
    excluded_domains {
      ...ExcludedDomainFragment
    }
  }
}

Variables

{"op_id": "abc123"}

Response

{
  "data": {
    "cancel_op": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "op_id": "12341234-1234-1234-1234-123412341234",
      "op_state": "running",
      "op_name": "your op name",
      "scheduled_timestamp": "1600793100.0",
      "scheduled_at": "2021-07-22T05:02:40.294996",
      "scheduled_at_date": "2022-08-06T19:43:07.150Z",
      "scheduled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "create_timestamp": "1600793100.0",
      "create_timestamp_iso": "2021-07-22T05:02:40.294996",
      "launched_timestamp": "1600793100.0",
      "launched_timestamp_iso": "2021-07-22T05:02:40.294996",
      "completed_timestamp": "1600793100.0",
      "completed_timestamp_iso": "2021-07-22T05:02:40.294996",
      "canceled_timestamp": "1600793100.0",
      "canceled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "duration_hms": "22:35:09",
      "op_type": "NodeZero",
      "weaknesses_count": 987,
      "host_tabs_count": 123,
      "credentials_count": 123,
      "proven_credentials_count": 987,
      "confirmed_credentials_count": 987,
      "unproven_credentials_count": 987,
      "feature_flags": [FeatureFlag],
      "impacts_headline_count": 987,
      "impact_paths_count": 123,
      "nodezero_script_url": "https://example.com/example",
      "nodezero_ip": "123.45.67.89",
      "etl_completed_at": "2021-07-22T05:02:40.294996",
      "start_paused": false,
      "minimum_run_time": 987,
      "maximum_run_time": 123,
      "paused_at": "2021-07-22T05:02:40.294996",
      "paused_by_user_account_uuid": "12341234-1234-1234-1234-123412341234",
      "paused_by_user_account": UserAccount,
      "op_template_name": "xyz789",
      "excluded_ips": [ExcludedIP],
      "excluded_domains": [ExcludedDomain]
    }
  }
}

Mutations

`create_asset_group`

Description

Create an asset group.
The asset group uses the scope configured in the given schedule_op_form to discover assets.

Response

Returns an AssetGroupOutput!

Arguments

Name	Description
`schedule_op_form` - `ScheduleOpFormInput!`	Scope for discovering assets.

Example

Query

mutation create_asset_group($schedule_op_form: ScheduleOpFormInput!) {
  create_asset_group(schedule_op_form: $schedule_op_form) {
    asset_group {
      ...AssetGroupFragment
    }
  }
}

Variables

{"schedule_op_form": ScheduleOpFormInput}

Response

{
  "data": {
    "create_asset_group": {"asset_group": AssetGroup}
  }
}

Mutations

`create_client_account`

Description

Create a client account and grant the current user access.

Response

Returns a ClientAccountOutput!

Arguments

Name	Description
`client_account_input` - `ClientAccountInput!`

Example

Query

mutation create_client_account($client_account_input: ClientAccountInput!) {
  create_client_account(client_account_input: $client_account_input) {
    client_account {
      ...ClientAccountFragment
    }
  }
}

Variables

{"client_account_input": ClientAccountInput}

Response

{
  "data": {
    "create_client_account": {
      "client_account": ClientAccount
    }
  }
}

Mutations

`create_user_account`

Description

Add a user to a given client account. The user will receive an invitation email along with temporary login credentials, if needed.

Response

Returns a UserAccount!

Arguments

Name	Description
`input` - `CreateUserAccountInput!`	Input data for creating user.

Example

Query

mutation create_user_account($input: CreateUserAccountInput!) {
  create_user_account(input: $input) {
    uuid
    email
    name
    user_role_id
    sign_in_type
    last_signed_in_at
  }
}

Variables

{"input": CreateUserAccountInput}

Response

{
  "data": {
    "create_user_account": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "email": "john.smith@example.com",
      "name": "John Smith",
      "user_role_id": "USER",
      "sign_in_type": "BASIC",
      "last_signed_in_at": "2021-07-22T05:02:40.294996"
    }
  }
}

Mutations

`delete_client_account`

Description

Delete a client account.

Response

Returns a Deleted!

Arguments

Name	Description
`client_account_uuid` - `String!`	Client account to delete.

Example

Query

mutation delete_client_account($client_account_uuid: String!) {
  delete_client_account(client_account_uuid: $client_account_uuid) {
    success
  }
}

Variables

{"client_account_uuid": "xyz789"}

Response

{"data": {"delete_client_account": {"success": false}}}

Mutations

`delete_op_template`

Description

Delete a pentest (aka "op") template.

Response

Returns a DeleteOpTemplateOutput!

Arguments

Name	Description
`op_template_name` - `String!`	Name of pentest template.
`op_type` - `String`	Type of pentest, see `OpType` for options.

Example

Query

mutation delete_op_template(
  $op_template_name: String!,
  $op_type: String
) {
  delete_op_template(
    op_template_name: $op_template_name,
    op_type: $op_type
  ) {
    op_template {
      ...OpTemplateFragment
    }
  }
}

Variables

{
  "op_template_name": "abc123",
  "op_type": "xyz789"
}

Response

{
  "data": {
    "delete_op_template": {"op_template": OpTemplate}
  }
}

Mutations

`delete_user_account`

Description

Delete a user from a given client account.

Response

Returns a UserAccount

Arguments

Name	Description
`email` - `EmailAddress!`	Email address of user to delete.
`client_account_uuid` - `String`	ID of client account to delete the user from. Defaults to the caller's client account.

Example

Query

mutation delete_user_account(
  $email: EmailAddress!,
  $client_account_uuid: String
) {
  delete_user_account(
    email: $email,
    client_account_uuid: $client_account_uuid
  ) {
    uuid
    email
    name
    user_role_id
    sign_in_type
    last_signed_in_at
  }
}

Variables

{
  "email": EmailAddress,
  "client_account_uuid": "abc123"
}

Response

{
  "data": {
    "delete_user_account": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "email": "john.smith@example.com",
      "name": "John Smith",
      "user_role_id": "USER",
      "sign_in_type": "BASIC",
      "last_signed_in_at": "2021-07-22T05:02:40.294996"
    }
  }
}

Mutations

`pause_op`

Description

Pause a pentest, if its current state allows it.

Response

Returns an OpTab!

Arguments

Name	Description
`op_id` - `String!`

Example

Query

mutation pause_op($op_id: String!) {
  pause_op(op_id: $op_id) {
    uuid
    op_id
    op_state
    op_name
    scheduled_timestamp
    scheduled_at
    scheduled_at_date
    scheduled_timestamp_iso
    create_timestamp
    create_timestamp_iso
    launched_timestamp
    launched_timestamp_iso
    completed_timestamp
    completed_timestamp_iso
    canceled_timestamp
    canceled_timestamp_iso
    duration_hms
    op_type
    weaknesses_count
    host_tabs_count
    credentials_count
    proven_credentials_count
    confirmed_credentials_count
    unproven_credentials_count
    feature_flags {
      ...FeatureFlagFragment
    }
    impacts_headline_count
    impact_paths_count
    nodezero_script_url
    nodezero_ip
    etl_completed_at
    start_paused
    minimum_run_time
    maximum_run_time
    paused_at
    paused_by_user_account_uuid
    paused_by_user_account {
      ...UserAccountFragment
    }
    op_template_name
    excluded_ips {
      ...ExcludedIPFragment
    }
    excluded_domains {
      ...ExcludedDomainFragment
    }
  }
}

Variables

{"op_id": "abc123"}

Response

{
  "data": {
    "pause_op": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "op_id": "12341234-1234-1234-1234-123412341234",
      "op_state": "running",
      "op_name": "your op name",
      "scheduled_timestamp": "1600793100.0",
      "scheduled_at": "2021-07-22T05:02:40.294996",
      "scheduled_at_date": "2023-02-06T20:43:07.150Z",
      "scheduled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "create_timestamp": "1600793100.0",
      "create_timestamp_iso": "2021-07-22T05:02:40.294996",
      "launched_timestamp": "1600793100.0",
      "launched_timestamp_iso": "2021-07-22T05:02:40.294996",
      "completed_timestamp": "1600793100.0",
      "completed_timestamp_iso": "2021-07-22T05:02:40.294996",
      "canceled_timestamp": "1600793100.0",
      "canceled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "duration_hms": "22:35:09",
      "op_type": "NodeZero",
      "weaknesses_count": 987,
      "host_tabs_count": 123,
      "credentials_count": 987,
      "proven_credentials_count": 123,
      "confirmed_credentials_count": 123,
      "unproven_credentials_count": 987,
      "feature_flags": [FeatureFlag],
      "impacts_headline_count": 123,
      "impact_paths_count": 123,
      "nodezero_script_url": "https://example.com/example",
      "nodezero_ip": "123.45.67.89",
      "etl_completed_at": "2021-07-22T05:02:40.294996",
      "start_paused": false,
      "minimum_run_time": 123,
      "maximum_run_time": 987,
      "paused_at": "2021-07-22T05:02:40.294996",
      "paused_by_user_account_uuid": "12341234-1234-1234-1234-123412341234",
      "paused_by_user_account": UserAccount,
      "op_template_name": "abc123",
      "excluded_ips": [ExcludedIP],
      "excluded_domains": [ExcludedDomain]
    }
  }
}

Mutations

`remove_domains_from_asset_group`

Description

Remove domains from an asset group.

Response

Returns an AssetGroupOutput!

Arguments

Name	Description
`asset_group_uuid` - `String!`	ID of asset group to update.
`domains` - `[StringNotEmpty]!`	List of domains to remove from the asset group's scope.

Example

Query

mutation remove_domains_from_asset_group(
  $asset_group_uuid: String!,
  $domains: [StringNotEmpty]!
) {
  remove_domains_from_asset_group(
    asset_group_uuid: $asset_group_uuid,
    domains: $domains
  ) {
    asset_group {
      ...AssetGroupFragment
    }
  }
}

Variables

{
  "asset_group_uuid": "abc123",
  "domains": [StringNotEmpty]
}

Response

{
  "data": {
    "remove_domains_from_asset_group": {
      "asset_group": AssetGroup
    }
  }
}

Mutations

`resume_op`

Description

Resume a pentest, if its current state allows it.

Response

Returns an OpTab!

Arguments

Name	Description
`op_id` - `String!`

Example

Query

mutation resume_op($op_id: String!) {
  resume_op(op_id: $op_id) {
    uuid
    op_id
    op_state
    op_name
    scheduled_timestamp
    scheduled_at
    scheduled_at_date
    scheduled_timestamp_iso
    create_timestamp
    create_timestamp_iso
    launched_timestamp
    launched_timestamp_iso
    completed_timestamp
    completed_timestamp_iso
    canceled_timestamp
    canceled_timestamp_iso
    duration_hms
    op_type
    weaknesses_count
    host_tabs_count
    credentials_count
    proven_credentials_count
    confirmed_credentials_count
    unproven_credentials_count
    feature_flags {
      ...FeatureFlagFragment
    }
    impacts_headline_count
    impact_paths_count
    nodezero_script_url
    nodezero_ip
    etl_completed_at
    start_paused
    minimum_run_time
    maximum_run_time
    paused_at
    paused_by_user_account_uuid
    paused_by_user_account {
      ...UserAccountFragment
    }
    op_template_name
    excluded_ips {
      ...ExcludedIPFragment
    }
    excluded_domains {
      ...ExcludedDomainFragment
    }
  }
}

Variables

{"op_id": "xyz789"}

Response

{
  "data": {
    "resume_op": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "op_id": "12341234-1234-1234-1234-123412341234",
      "op_state": "running",
      "op_name": "your op name",
      "scheduled_timestamp": "1600793100.0",
      "scheduled_at": "2021-07-22T05:02:40.294996",
      "scheduled_at_date": "2022-08-06T19:43:07.150Z",
      "scheduled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "create_timestamp": "1600793100.0",
      "create_timestamp_iso": "2021-07-22T05:02:40.294996",
      "launched_timestamp": "1600793100.0",
      "launched_timestamp_iso": "2021-07-22T05:02:40.294996",
      "completed_timestamp": "1600793100.0",
      "completed_timestamp_iso": "2021-07-22T05:02:40.294996",
      "canceled_timestamp": "1600793100.0",
      "canceled_timestamp_iso": "2021-07-22T05:02:40.294996",
      "duration_hms": "22:35:09",
      "op_type": "NodeZero",
      "weaknesses_count": 987,
      "host_tabs_count": 123,
      "credentials_count": 123,
      "proven_credentials_count": 123,
      "confirmed_credentials_count": 987,
      "unproven_credentials_count": 123,
      "feature_flags": [FeatureFlag],
      "impacts_headline_count": 987,
      "impact_paths_count": 987,
      "nodezero_script_url": "https://example.com/example",
      "nodezero_ip": "123.45.67.89",
      "etl_completed_at": "2021-07-22T05:02:40.294996",
      "start_paused": true,
      "minimum_run_time": 123,
      "maximum_run_time": 987,
      "paused_at": "2021-07-22T05:02:40.294996",
      "paused_by_user_account_uuid": "12341234-1234-1234-1234-123412341234",
      "paused_by_user_account": UserAccount,
      "op_template_name": "abc123",
      "excluded_ips": [ExcludedIP],
      "excluded_domains": [ExcludedDomain]
    }
  }
}

Mutations

`save_op_template`

Description

Create or update a pentest (aka "op") template.

Response

Returns a SaveOpTemplateOutput!

Arguments

Name	Description
`op_template_name` - `String!`	Name of pentest template. The name uniquely identifies the template in the client account.
`schedule_op_form` - `ScheduleOpFormInput!`	Input data for scheduling pentest.

Example

Query

mutation save_op_template(
  $op_template_name: String!,
  $schedule_op_form: ScheduleOpFormInput!
) {
  save_op_template(
    op_template_name: $op_template_name,
    schedule_op_form: $schedule_op_form
  ) {
    op_template {
      ...OpTemplateFragment
    }
  }
}

Variables

{
  "op_template_name": "abc123",
  "schedule_op_form": ScheduleOpFormInput
}

Response

{
  "data": {
    "save_op_template": {"op_template": OpTemplate}
  }
}

Mutations

`schedule_op_template`

Description

Schedule a pentest from a template.

Response

Returns a ScheduleOpOutput!

Arguments

Name	Description
`op_template_name` - `String!`	Name of pentest template.
`op_name` - `String`	Name of the pentest, defaults to the name in pentest template.
`schedule_op_form` - `ScheduleOpFormInput`	Optional parameters that, if set, override the corresponding parameters in the pentest template.
`agent_name` - `String`	Assign an h3-cli agent to automatically launch NodeZero for this pentest
`schedule_name` - `String`	The automated schedule to which this pentest is assigned

Example

Query

mutation schedule_op_template(
  $op_template_name: String!,
  $op_name: String,
  $schedule_op_form: ScheduleOpFormInput,
  $agent_name: String,
  $schedule_name: String
) {
  schedule_op_template(
    op_template_name: $op_template_name,
    op_name: $op_name,
    schedule_op_form: $schedule_op_form,
    agent_name: $agent_name,
    schedule_name: $schedule_name
  ) {
    op {
      ...OpFragment
    }
  }
}

Variables

{
  "op_template_name": "xyz789",
  "op_name": "xyz789",
  "schedule_op_form": ScheduleOpFormInput,
  "agent_name": "xyz789",
  "schedule_name": "abc123"
}

Response

{"data": {"schedule_op_template": {"op": Op}}}

Mutations

`update_asset_group_template`

Description

Update an asset group's configuration.

Response

Returns a SaveOpTemplateOutput!

Arguments

Name	Description
`asset_group_uuid` - `String!`	ID of asset group.
`schedule_op_form` - `ScheduleOpFormInput!`	Scope for discovering assets.

Example

Query

mutation update_asset_group_template(
  $asset_group_uuid: String!,
  $schedule_op_form: ScheduleOpFormInput!
) {
  update_asset_group_template(
    asset_group_uuid: $asset_group_uuid,
    schedule_op_form: $schedule_op_form
  ) {
    op_template {
      ...OpTemplateFragment
    }
  }
}

Variables

{
  "asset_group_uuid": "xyz789",
  "schedule_op_form": ScheduleOpFormInput
}

Response

{
  "data": {
    "update_asset_group_template": {
      "op_template": OpTemplate
    }
  }
}

Mutations

`update_client_account`

Description

Update a client account.

Response

Returns a ClientAccount!

Arguments

Name	Description
`client_account_input` - `ClientAccountUpdateInput!`

Example

Query

mutation update_client_account($client_account_input: ClientAccountUpdateInput!) {
  update_client_account(client_account_input: $client_account_input) {
    uuid
    parent_uuid
    child_client_accounts {
      ...ClientAccountFragment
    }
    company_name
    company_short_name
    company_logo_url
    company_colors {
      ...BrandColorFragment
    }
    white_label_reports_enabled
    white_label_reports_cascade
    row_created_at
    session_user_role_id
  }
}

Variables

{"client_account_input": ClientAccountUpdateInput}

Response

{
  "data": {
    "update_client_account": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "parent_uuid": "12341234-1234-1234-1234-123412341234",
      "child_client_accounts": [ClientAccount],
      "company_name": "Horizon3 AI, Inc",
      "company_short_name": "H3",
      "company_logo_url": "https://example.com/example",
      "company_colors": [BrandColor],
      "white_label_reports_enabled": false,
      "white_label_reports_cascade": false,
      "row_created_at": "2021-07-22T05:02:40.294996",
      "session_user_role_id": "USER"
    }
  }
}

Mutations

`update_user_account`

Description

Update a user and their role for a given client account.

Response

Returns a UserAccount!

Arguments

Name	Description
`input` - `UpdateUserAccountInput!`	Input data for updating user.

Example

Query

mutation update_user_account($input: UpdateUserAccountInput!) {
  update_user_account(input: $input) {
    uuid
    email
    name
    user_role_id
    sign_in_type
    last_signed_in_at
  }
}

Variables

{"input": UpdateUserAccountInput}

Response

{
  "data": {
    "update_user_account": {
      "uuid": "12341234-1234-1234-1234-123412341234",
      "email": "john.smith@example.com",
      "name": "John Smith",
      "user_role_id": "USER",
      "sign_in_type": "BASIC",
      "last_signed_in_at": "2021-07-22T05:02:40.294996"
    }
  }
}

Types

AWSAccountId

Description

String scalar type with AWS Account ID format required (a 12-digit number).

Example

AWSAccountId

Enum Value	Description
`FREE_TRIAL`	Free trial access with certain limitations.
`READONLY`	Read-only access.
`FULL`	Full access.
`POV`	Proof-of-value access
`C_PLUS`	Consulting+ access.
`MSP`	Managed Service Provider

Field Name	Description
`uuid` - `String!`	ID of action log.
`start_time` - `Datetime!`	Timestamp at the start of action, in ISO format (UTC).
`endpoint_uuid` - `String`	ID of host targeted by action.
`endpoint_ip` - `String`	IP address of host targeted by action.
`end_time` - `Datetime!`	Timestamp at the end of action, in ISO format (UTC).
`cmd` - `String!`	Attack command run in action.
`module_id` - `String!`	Name of attack module used in action.
`module_name` - `String`	Title name of attack module used in action.
`module_description` - `String`	Description of attack module used in action.
`module_meta` - `ModuleMeta`	Metadata for the attack module used in action.
`target_h3_names` - `[String]`	List of assets and weaknesses associated with action. Assets include the IP, service, application, URL, or data store being targeted.
`exit_code` - `String!`	Exit code from attack command run in action.
`op_id` - `String!`	ID of pentest associated with action.
`op_snapshot_id` - `String!`	ID of pentest snapshot associated with action.

Field Name	Description
`page_info` - `PageInfo`	Pagination of response.
`action_logs` - `[ActionLog]!`	List of action logs.

Field Name	Description
`uuid` - `String!`	ID of asset group
`name` - `String!`	Name of asset group.
`op_template_uuid` - `String!`	ID of pentest template for asset group.
`op_template` - `OpTemplate!`	Data of pentest template for asset group.
`user_account_uuid` - `String!`	ID of user that created the asset group.
`user_account_name` - `String!`	Name of user account that created the asset group.
`client_account_uuid` - `String!`	ID of client account that created the asset group.
`client_account_company_name` - `String!`	Company name on the client account that created the asset group.
`last_ead_etl_completed_at` - `Datetime`	Timestamp when the last asset discovery completed for this asset group.
`created_at` - `Datetime!`	Timestamp when the asset group was created.
`updated_at` - `Datetime`	Timestamp when the asset group was last updated.
`assets_count` - `Int!`	The number of domain and IP assets in this asset group.

Field Name	Description
`page_info` - `PageInfo`	Pagination of response.
`asset_groups` - `[AssetGroup]!`	List of asset groups.

Enum Value	Description
`NOT_ASSOCIATED`	User has no association with the client account.
`DEMO_FREE_TRIAL`	User has free-trial access in the client account.
`USER`	User has non-admin access in the client account.
`READONLY`	User has read-only access in the client account.
`ORG_ADMIN`	User has organizational admin access in the client account.
`H3_ADMIN`	User has Horizon3.ai admin access in the client account.
`DELETED`	User has been deleted from the client account.
`H3ADMIN`	Use `H3_ADMIN` instead.
`ORG_READONLY`	Use `READONLY` instead.
`DEMO_READONLY`	Use `READONLY` instead.

Field Name	Description
`type` - `BrandColorType!`	Primary or Secondary.
`color` - `HexColor!`	The color in hex notation.

Field Name	Description
`uuid` - `String!`	ID of client account.
`parent_uuid` - `String`	ID of parent client account.
`child_client_accounts` - `[ClientAccount!]!`	List of child client accounts, also known as sub-client accounts.
`company_name` - `String!`	Full company name.
`company_short_name` - `String!`	Short name of company.
`company_logo_url` - `String`	Company logo URL.
`company_colors` - `[BrandColor!]`	Company color scheme.
`white_label_reports_enabled` - `Boolean`	Flag to enable co-branded reports.
`white_label_reports_cascade` - `Boolean`	Flag to cascade co-branded reports to child accounts, if applicable.
`row_created_at` - `Datetime`	Timestamp when the account was created, in ISO format (UTC).
`session_user_role_id` - `AuthzRole`	Role of the current user in this client account.

Input Field	Description
`CompanyName` - `StringNotEmpty!`	Full company name.
`company_short_name` - `StringNotEmpty`	Short company name.
`access_level` - `AccessLevel!`	Access level of client account.
`parent_uuid` - `String`	ID of client account to assign as parent.

Input Field	Description
`uuid` - `String!`	Client account to update.
`CompanyName` - `StringNotEmpty`	Full company name.
`company_short_name` - `StringNotEmpty`	Short company name.
`company_colors` - `[BrandColorInput!]`	Company color scheme.
`white_label_reports_enabled` - `Boolean`	Flag to enable co-branded reports.
`white_label_reports_cascade` - `Boolean`	Flag to cascade co-branded reports to child accounts, if applicable.

Field Name	Description
`page_info` - `PageInfo`	Pagination of response.
`client_accounts` - `[ClientAccount]!`	List of client accounts.

Input Field	Description
`name` - `String!`	Name of user.
`email` - `EmailAddress!`	Email of user.
`client_account_uuid` - `String`	ID of client account to add the user to. Defaults to the current user client account.
`user_role_id` - `AuthzRole!`	Role of user in the given client account.

Enum Value	Description
`Application`
`ApplicationLoginForm`
`ApplicationFingerprint`
`ApplicationResolvedFromFingerprint`
`ApplicationVuln`
`AzureDomain`
`CleanupRequired`
`CloudAccount`
`CloudService`
`CloudServiceCred`
`CloudResource`
`CloudResourceVuln`
`CloudRole`
`CloudRoleVuln`
`Certificate`
`Credential`
`CredentialVuln`
`DNSAddress`
`GitAccount`
`GitRepoSensitiveFinding`
`Endpoint`
`EndpointCred`
`EndpointVuln`
`EnvironmentVuln`
`ExternalDomain`
`ExternalDomainVuln`
`Group`
`InterestingResource`
`InterestingResourceCred`
`InterestingResourceVuln`
`LandingPage`
`LandingPageCred`
`LDAPDomain`
`LDAPDomainVuln`
`LoginForm`
`LoginFormCred`
`LootResource`
`ModuleInstance`
`NodeZero`
`PotentialCredential`
`PotentialCredentialVuln`
`PrivEscEvent`
`Proof`
`ProofFailure`
`RelayEvent`
`Repo`
`RepoCred`
`RepoVuln`
`RoutineInstance`
`Scope`
`Service`
`ServiceVuln`
`ServiceCred`
`User`
`Weakness`
`Address`	Address is mapped to an Endpoint
`AddressState`
`ApplicationHasLandingPageRelationship`
`ApplicationHasInterestingResourceRelationship`
`Artifact`
`ArtifactState`
`CloudProvider`
`CloudAccountHostsCloudResourceRelationship`
`CloudAccountHostsRepoRelationship`
`CloudAccountHasRolesRelationship`
`CloudAccountState`
`CloudResourceState`
`CloudResourceAccessedByRelationship`
`Company`
`CredentialLinkedToPotentialCredentialRelationship`
`Data`	Data is mapped to a LootResource
`DNSHost`
`DNSHostState`
`DNSServerServesDNSZoneRelationship`
`DNSZone`
`Environment`
`EndpointRole`
`EndpointState`
`ExternalData`
`ExternalDomainState`
`GitAccountState`
`ImplantAttempt`
`LoginFormState`
`LDAPComputer`
`LDAPComputerState`
`Key`
`MitreTactic`
`MitreTechnique`
`MitreSubtechnique`
`ModuleState`
`NodeZeroState`
`PasswordPolicy`
`Port`
`PotentialPort`
`PotentialExternalDomain`
`PotentialExternalDomainState`
`RoutineState`
`ServiceState`
`VHost`
`UserState`
`OpFinding`
`ApplicationVulnEvidence`
`CredentialEvidence`
`CredentialVulnEvidence`
`EndpointEvidence`
`EnvironmentVulnEvidence`
`InterestingResourceEvidence`
`LDAPDomainEvidence`
`LootResourceEvidence`
`PotentialCredentialEvidence`
`RepoEvidence`
`RepoCredEvidence`
`ScopeEvidence`
`ServiceEvidence`
`ServiceCredEvidence`
`ServiceVulnEvidence`
`UserEvidence`
`ModuleCred`
`ModuleCredentialVuln`
`ModuleEndpoint`
`ModuleEnvironmentVuln`
`ModuleLDAPDomain`
`ModuleLootResource`
`ModulePotentialCredential`
`ModuleRepo`
`ModuleRepoCred`
`ModuleScope`
`ModuleService`
`ModuleServiceCred`
`ModuleServiceVuln`
`ModuleUser`
`AccessRequest`
`ActionLog`
`Agent`
`AgentCommand`
`AssetGroup`
`AttackVector`
`AVNode`
`BestPracticeCategory`
`BestPracticeIndicator`
`BestPracticeEdge`
`ContextScore`
`CredentialTab`
`CredentialAccessEdge`
`DatabaseRepo`
`DockerRegistry`
`DownstreamEdge`
`EdgeContext`
`FindingEvidenceEdgeTab`
`FindingEvent`
`FileShare`
`GitRepo`
`HFSResourceItem`
`HFSResourceItemGroup`
`HostTab`
`Impact`
`ImpactEdge`
`ImpactEdgeGroup`
`ModuleMeta`
`NodeContext`
`Op`
`OpSeries`
`OpStatus`
`OpSimilarity`
`OpReport`
`OpTab`
`OpTemplate`
`PasswordAnalysis`
`Pentest`
`Proofs`
`RiskFactor`
`RiskFactorEdge`
`RiskFactorEdgeXop`
`RiskFactorType`
`RiskFactorXop`
`S3Bucket`
`Schedule`
`ScheduledAction`
`Share`
`ShareTab`
`ShareServiceTab`
`ServiceTab`
`ServiceProcess`
`ServiceTypeTab`
`ServiceTypeProcessTab`
`Subnet`
`Vuln`
`WeaknessTab`
`WebShareTab`
`WebShareTabUrl`
`GitRepoXop`
`ExternalDomainXop`
`HostTabXop`
`S3BucketXop`
`WeaknessTabXop`
`FindingEvidenceEdgeTabXop`
`ServiceTabXop`
`WebShareTabXop`
`CertificateXop`
`ClientAccount`
`UserAccount`
`ETLPipelineInstance`

Field Name	Description
`op_id` - `String!`	The op that excluded the domain.
`domain` - `String!`	The external domain that was excluded.

Field Name	Description
`op_id` - `String!`	The op that excluded the IP.
`ip` - `String!`	The IP that was excluded.

Field Name	Description
`name` - `String!`	The name of the advanced configuration option.
`value` - `Boolean!`	Indicates whether the option is enabled or disabled.
`property_name` - `String`	Human-friendly name for this advanced configuration option.
`property_description` - `String`	Description for this advanced configuration option.
`category_name` - `String`	Category of this advanced configuration option.
`category_description` - `String`	Category description.
`risk` - `FeatureFlagRiskType`	The disruption risk associated with this advanced configuration option.
`enables_min_runtime` - `Boolean`	Indicates whether this advanced configuration option should be used in conjunction with ScheduleOpFormInput.minimum_run_time.
`enables_password_spray` - `Boolean`	Indicates whether this advanced configuration option should be used in conjunction with ScheduleOpFormInput.passwords_to_spray.

Enum Value	Description
`none`	The feature has no risk of disruption to your environment.
`low`	The feature has low risk of disruption to your environment.
`moderate`	The feature has moderate risk of disruption to your environment.
`high`	The feature has high risk of disruption to your environment.

Field Name	Description
`field_name` - `StringNoWhitespace!`	Name of parameter being filtered by.
`values` - `[String]`	Values being filtered for.

Input Field	Description
`field_name` - `StringNoWhitespace!`	Name of parameter to filter by.
`values` - `[String]`	Values to filter for.

Field Name	Description
`name` - `String!`	Name of the git account.
`source` - `GitAccountSource!`	The git service associated with this git account.

Input Field	Description
`name` - `StringNoWhitespace!`	Name of the git account.
`source` - `GitAccountSource!`	The git service associated with this git account.

Enum Value	Description
`GitLab`	The git account is associated with GitLab
`GitHub`	The git account is associated with GitHub
`Bitbucket`	The git account is associated with BitBucket.

Field Name	Description
`mitre_tactic_id` - `String!`	The MITRE Tactic ID
`mitre_tactic` - `MitreTactic`	The MITRE Tactic
`mitre_technique_id` - `String!`	The MITRE Technique ID
`mitre_technique` - `MitreTechnique`	The MITRE Technique
`mitre_subtechnique_id` - `String`	The MITRE Subtechnique ID
`mitre_subtechnique` - `MitreSubtechnique`	The MITRE Subtechnique

Field Name	Description
`id` - `String!`	The MITRE Subtechnique ID
`mitre_technique_id` - `String`	The MITRE Technique ID that is the parent of this Subtechnique
`name` - `String`	The MITRE Subtechnique name
`description` - `String`	The MITRE Subtechnique description
`url` - `String`	The documentation URL for the MITRE Subtechnique

Field Name	Description
`id` - `String!`	ID of attack module.
`name` - `String`	Name of attack module.
`description` - `String`	Description of attack module.
`mitre_mappings` - `[MitreMapping]`	MITRE Tactics, Techniques, and Subtechniques associated with this attack module

Field Name	Description
`op_id` - `String`	ID of pentest.
`op_type` - `OpType`	Type of pentest.
`op_state` - `String!`	State of pentest.
`op_name` - `String!`	Name of pentest.
`scheduled_timestamp_iso` - `String!`	Timestamp of pentest scheduling, in ISO format (UTC).
`scheduled_at` - `Datetime!`	Timestamp of pentest scheduling
`scheduled_at_date` - `Date!`	Date of pentest scheduling
`completed_timestamp_iso` - `String`	Timestamp of pentest completion, in ISO format (UTC).
`launched_timestamp_iso` - `String`	Timestamp of pentest launch, in ISO format (UTC).
`confirmed_credentials_count` - `Int`	Number of confirmed credentials found.
`weaknesses_count` - `Int`	Number of weaknesses found (weakness INSTANCEs, not unique weakness IDs).
`in_scope_hosts_count` - `Int`	Number of hosts found in scope.
`feature_flags` - `[FeatureFlag]`	Advanced configuration settings for this pentest.
`nodezero_script_url` - `String`	URL of the script that downloads and launches NodeZero.
`duration_hms` - `String`	Pentest duration in HH:MM:SS format.
`op_template_name` - `String`	The OpTemplate used for this pentest.
`impact_paths_count` - `Int`	Number of impact paths in the pentest.

Field Name	Description
`uuid` - `String`	ID of pentest.
`op_id` - `String`	ID of pentest. Same as `uuid`.
`op_state` - `String!`	State of pentest: scheduled provisioning ready running complete post-processing done cancelling canceled paused error
`op_name` - `String!`	Name of pentest.
`scheduled_timestamp` - `Float!`	Timestamp of pentest scheduling, in epoch seconds.
`scheduled_at` - `Datetime!`	Timestamp of pentest scheduling
`scheduled_at_date` - `Date!`	Date of pentest scheduling
`scheduled_timestamp_iso` - `String!`	Timestamp of pentest scheduling, in ISO format (UTC).
`create_timestamp` - `Int!`	Timestamp of pentest creation, in epoch seconds.
`create_timestamp_iso` - `String!`	Timestamp of pentest creation, in ISO format (UTC).
`launched_timestamp` - `Int`	Timestamp of pentest launching, in epoch seconds.
`launched_timestamp_iso` - `String`	Timestamp of pentest launching, in ISO format (UTC).
`completed_timestamp` - `Float`	Timestamp of pentest completion, in epoch seconds.
`completed_timestamp_iso` - `String`	Timestamp of pentest completion, in ISO format (UTC).
`canceled_timestamp` - `Int`	Timestamp of pentest cancellation, in epoch seconds.
`canceled_timestamp_iso` - `String`	Timestamp of pentest cancellation, in ISO format (UTC).
`duration_hms` - `String`	Pentest duration in HH:MM:SS format .
`op_type` - `OpType`	Type of pentest.
`weaknesses_count` - `Int`	Number of weaknesses found (weakness INSTANCEs, not unique weakness IDs).
`host_tabs_count` - `Int`	Number of hosts found in and out of scope. Same as `endpoints_count`.
`credentials_count` - `Int`	Number of credentials and potential credentials found.
`proven_credentials_count` - `Int`	Number of credentials with proof.
`confirmed_credentials_count` - `Int`	Number of credentials with proof. Alias of `proven_credentials_count`.
`unproven_credentials_count` - `Int`	Number of credentials without proof.
`feature_flags` - `[FeatureFlag]`	Advanced configuration settings for this pentest.
`impacts_headline_count` - `Int`	Number of impacts in the pentest, which generally refers to the number of assets affected by an impact.
`impact_paths_count` - `Int`	Number of impact paths in the pentest.
`nodezero_script_url` - `String`	URL of the script that downloads and launches NodeZero.
`nodezero_ip` - `String`	The IP address where NodeZero was launched.
`etl_completed_at` - `Datetime`	Timestamp of pentest post-processing completion, in ISO format (UTC).
`start_paused` - `Boolean`	Start paused.
`minimum_run_time` - `Int`	Op minimum run-time, in minutes.
`maximum_run_time` - `Int`	Op maximum run-time, in minutes.
`paused_at` - `Datetime`	Time when the pentest was most recently paused.
`paused_by_user_account_uuid` - `String`	ID of the user that most recently paused the pentest.
`paused_by_user_account` - `UserAccount`	Data of user account that most recently paused the pentest.
`op_template_name` - `String`	The OpTemplate used for this pentest.
`excluded_ips` - `[ExcludedIP]`	IPs that were excluded from the pentest scope. Applies to external pentests only.
`excluded_domains` - `[ExcludedDomain]`	Domains that were excluded from the pentest scope. Applies to external pentests only.

Field Name	Description
`page_info` - `PageInfo`	Pagination of response.
`op_tabs` - `[OpTab]!`	List of pentests.

Field Name	Description
`uuid` - `String!`	ID of pentest template.
`user_account_uuid` - `String!`	ID of user account that created the pentest template.
`client_account_uuid` - `String!`	ID of client account that created pentest template.
`op_template_name` - `String!`	Name of template.
`op_type` - `OpType!`	Type of pentest this template applies to. "NodeZero" for internal pentests; "ExternalAttack" for external pentests.
`schedule_op_form` - `ScheduleOpForm!`	Template data for scheduling pentests.
`row_created_at` - `Datetime!`	Timestamp when the template was created.
`row_updated_at` - `Datetime`	Timestamp when the template was last updated.

Enum Value	Description
`NodeZero`	Internal pentest.
`ExternalAssetDiscovery`	External asset discovery.
`ExternalAttack`	External pentest.