OBJECT
Mutation
link GraphQL Schema definition
- type Mutation {
- # Change asset details. This mutation doesn't support reset of list-based values
- # back to system chosen values.
- # e.g. to reset a user defined asset type to the value given it by the system one
- # should use updateAssetWithRemove with type='_RemoveUserDefinedValue'
- #
- # Arguments
- # name: null is no change to value
- # type: null is no change to value
- # location: null is no change to value
- # description: null is no change to value
- # customFields: null is no change to value
- # purdueLevel: null is no change to value
- # criticality: null is no change to value
- # id: [Not documented]
- (
- String, :
- AssetType, :
- String, :
- String, :
- CustomFieldValue, :
- PurdueLevel, :
- Criticality, :
- ID! :
- ): Asset! @deprecated( reason: "Replaced with updateAssetWithRemove" )
- # Change asset details (with the ability to reset list-based values back to system
- # values)
- # moving the asset's ips to another segments is not supported by this mutation
- # to do that use 'setIpSegments' mutation
- #
- # Arguments
- # name: null is no change to value
- # type: null is no change to value
- # location: null is no change to value
- # description: null is no change to value
- # customFields: null is no change to value
- # purdueLevel: null is no change to value
- # criticality: null is no change to value
- # id: [Not documented]
- (
- String, :
- UserDefinedAssetType, :
- String, :
- String, :
- CustomFieldValue, :
- UserDefinedPurdueLevel, :
- UserDefinedCriticality, :
- ID! :
- ): Asset!
- # Change assets details. This mutation doesn't support reset of list-based values
- # back to system chosen values.
- # e.g. to reset user defined assets types to the values given them by the system
- # one should use bulkEditAssetsWithRemove with type='_RemoveUserDefinedValue'
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- # name: null is no change to value
- # type: null is no change to value
- # location: null is no change to value
- # description: null is no change to value
- # customFields: null is no change to value
- # purdueLevel: null is no change to value
- # criticality: null is no change to value
- # segment: Segment's Id
- (
- AssetExpressionsParams, :
- String, :
- AssetSortParams!], : [
- Boolean, :
- Int, :
- String, :
- AssetType, :
- String, :
- String, :
- CustomFieldValue, :
- PurdueLevel, :
- Criticality, :
- ID :
- ): BulkOpAssetsResult! @deprecated( reason: "Replaced with bulkEditAssetsWithRemove" )
- # Change assets details (with the ability to reset list-based values back to
- # system values)
- # segment bulk edit is supported only for assets with one ip
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- # name: null is no change to value
- # type: null is no change to value
- # location: null is no change to value
- # description: null is no change to value
- # customFields: null is no change to value
- # purdueLevel: null is no change to value
- # criticality: null is no change to value
- # segment: Segment's Id
- (
- AssetExpressionsParams, :
- String, :
- AssetSortParams!], : [
- Boolean, :
- Int, :
- String, :
- UserDefinedAssetType, :
- String, :
- String, :
- CustomFieldValue, :
- UserDefinedPurdueLevel, :
- UserDefinedCriticality, :
- ID :
- ): BulkOpAssetsResult!
- # Hide assets
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- # comment: [Not documented]
- (
- AssetExpressionsParams, :
- String, :
- AssetSortParams!], : [
- Boolean, :
- Int, :
- String :
- ): BulkOpAssetsResult!
- # Restore assets
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- (
- AssetExpressionsParams, :
- String, :
- AssetSortParams!], : [
- Boolean, :
- Int :
- ): BulkOpAssetsResult
- # Hides an asset
- #
- # Arguments
- # id: [Not documented]
- # comment: [Not documented]
- ID!, : String): HiddenAsset! ( :
- # Restores a hidden asset
- #
- # Arguments
- # id: [Not documented]
- ID!): Asset! ( :
- # Generate attack vector for asset
- #
- # Arguments
- # dstAsset: [Not documented]
- # constraints: [Not documented]
- (
- ID!, :
- AttackVectorLimitationsParams! :
- ): Job!
- # Rename backplane
- #
- # Arguments
- # id: [Not documented]
- # name: [Not documented]
- ID!, : String!): Backplane! ( :
- # Resolve unresolved event
- #
- # Arguments
- # id: [Not documented]
- # comment: [Not documented]
- ID!, : String): Event! ( :
- # Resolve unresolved events with filter
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- # comment: [Not documented]
- (
- EventsExpressionsParams, :
- String, :
- EventsSortParams!], : [
- Boolean, :
- Int, :
- String :
- ): ResolveEventsResponse!
- # Create capture for event
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # ReAct on an event
- #
- # Arguments
- # eventId: [Not documented]
- # actionId: [Not documented]
- ID!, : ID!): Job! ( :
- # set base revision
- #
- # Arguments
- # asset: ID of the asset whose snapshot we want to set base
- # revision: Base revision
- ID!, : ID!): Revision! ( :
- # Create or edit tag properties
- #
- # Arguments
- # assetId: The asset id of the tag that is modified
- # abbAc800Tag: [Not documented]
- ID!, : AbbAc800FullTagParams): AssetTags! ( :
- # Delete an existing tag
- #
- # Arguments
- # assetId: The asset id of the tag that is modified
- # abbAc800Tag: [Not documented]
- ID!, : AbbAc800BaseTagParams): AssetTags! ( :
- # Set tag group
- #
- # Arguments
- # id: ID
- # name: the group name
- # items: The list of tags in this group
- # tagType: The type of the group
- (
- ID!, :
- String!, :
- TagGroupItemParams!]!, : [
- TagType! :
- ): TagGroup!
- # Archive tag group
- #
- # Arguments
- # id: [Not documented]
- ID!): TagGroup! ( :
- # Create a new tag group
- #
- # Arguments
- # name: the group name
- # items: The list of tags in this group
- # tagType: The type of the group
- (
- String!, :
- TagGroupItemParams!]!, : [
- TagType! :
- ): TagGroup!
- # New Tag Value policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # schedule: Schedule Group
- # tagGroup: Tag group
- # min: min of value group
- # max: max of value group
- # any: Any value
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- TagPolicyEvent!, :
- Group!, :
- Group!, :
- String, :
- String, :
- Boolean :
- ): Policy!
- # Update Tag Value policy
- #
- # Arguments
- # id: ID
- # valueGroup: Value Group
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # schedule: Schedule Group
- # tagGroup: Tag group
- # min: min of value group
- # max: max of value group
- # any: Any value
- (
- ID!, :
- Group!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- TagPolicyEvent!, :
- Group!, :
- Group!, :
- String, :
- String, :
- Boolean :
- ): Policy!
- # Set the system time, this will result in a system restart
- #
- # Arguments
- # time: Time in RFC3339
- # location: System location as defined in TZData
- String, : String): SystemInfo! ( :
- # Add user
- #
- # Arguments
- # fullName: [Not documented]
- # userName: [Not documented]
- # groups: [Not documented]
- # password: [Not documented]
- String!, : String!, : [ID!]!, : String!): User! ( :
- # Change user details
- #
- # Arguments
- # userName: The username that performs the operation
- # fullName: Requested full user name
- String, : String): User! ( :
- # Change the logged-in (your own) user's password (only for local users)
- #
- # Arguments
- # newPassword: New Password
- # password: Current password
- # userName: The username that performs the operation
- String, : String, : String): User! ( :
- # Set user's groups
- #
- # Arguments
- # userName: The username to set the group for
- # newGroups: [Not documented]
- String, : [ID!]!): User! ( :
- # Deletes the user
- #
- # Arguments
- # userName: [Not documented]
- String!): User! ( :
- # Sets password of another user (admin only), to reset the logged-in user, use
- # 'setPassword'
- #
- # Arguments
- # password: New Password
- # userName: The username to set password for
- String!, : String!): User! ( :
- # Set ips segment
- #
- # Arguments
- # assetId: Asset Id
- # ipSegments: Ip segments list
- ID!, : [IpSegmentArgs!]!): [IpSegment!]! ( :
- # Set an asset group
- #
- # Arguments
- # id: ID
- # name: The group name
- # type: The group type
- # assetsIds: The list of asset IDs in this group
- # ips: The list of IPs in this group
- # startIp: The starting IP for the range
- # endIp: The ending IP for the range
- # assetType: The asset type to match. leave empty to any asset
- # type
- # family: The family to match. leave empty to any family
- # vlan: The VLAN of the segment
- # description: The segment description
- (
- ID!, :
- String!, :
- AssetGroupType!, :
- ID!], : [
- String!], : [
- String, :
- String, :
- AssetType, :
- String, :
- String, :
- String :
- ): AssetGroup!
- # Create a new asset group
- #
- # Arguments
- # name: The group name
- # type: The group type
- # assetsIds: The list of asset IDs in this group
- # ips: The list of IPs in this group
- # startIp: The starting IP for the range
- # endIp: The ending IP for the range
- # assetType: The asset type to match. leave empty to any asset
- # type
- # family: The family to match. leave empty to any family
- # vlan: The VLAN of the segment
- # description: The segment description
- (
- String!, :
- AssetGroupType!, :
- ID!], : [
- String!], : [
- String, :
- String, :
- AssetType, :
- String, :
- String, :
- String :
- ): AssetGroup!
- # Archive an asset Group
- #
- # Arguments
- # id: [Not documented]
- ID!): AssetGroup! ( :
- # Set a schedule group
- #
- # Arguments
- # id: ID
- # name: The group name
- # type: The group type
- # start: The start time of the interval
- # end: The end time of the interval
- # schedules: The intervals list
- (
- ID!, :
- String!, :
- String!, :
- Time, :
- Time, :
- TypedIntervalParams!] : [
- ): ScheduleGroup!
- # Create a new schedule group
- #
- # Arguments
- # name: The group name
- # type: The group type
- # start: The start time of the interval
- # end: The end time of the interval
- # schedules: The intervals list
- (
- String!, :
- String!, :
- Time, :
- Time, :
- TypedIntervalParams!] : [
- ): ScheduleGroup!
- # Archive a schedule group
- #
- # Arguments
- # id: [Not documented]
- ID!): ScheduleGroup! ( :
- # Set rule group
- #
- # Arguments
- # id: ID
- # name: the group name
- # items: The list of rules in this group
- ID!, : String!, : [Float!]!): RuleGroup! ( :
- # Create a new rule group
- #
- # Arguments
- # name: the group name
- # items: The list of rules in this group
- String!, : [Float!]!): RuleGroup! ( :
- # Archive a rule group
- #
- # Arguments
- # id: [Not documented]
- ID!): RuleGroup! ( :
- # Set protocol list group
- #
- # Arguments
- # id: ID
- # name: the group name
- # items: The list of protocols in this group
- (
- ID!, :
- String!, :
- ProtocolListItemParams!]! : [
- ): ProtocolGroup!
- # Create a new protocol group
- #
- # Arguments
- # name: the group name
- # items: The list of protocols in this group
- String!, : [ProtocolListItemParams!]!): ProtocolGroup! ( :
- # Archive a protocol group
- #
- # Arguments
- # id: [Not documented]
- ID!): ProtocolGroup! ( :
- # Set port list group
- #
- # Arguments
- # id: ID
- # name: the group name
- # items: The list of ports in this group
- ID!, : String!, : [PortListItemParams!]!): PortGroup! ( :
- # Create a new port group
- #
- # Arguments
- # name: the group name
- # items: The list of ports in this group
- String!, : [PortListItemParams!]!): PortGroup! ( :
- # Archive a port group
- #
- # Arguments
- # id: [Not documented]
- ID!): PortGroup! ( :
- # Set Smtp server
- #
- # Arguments
- # name: Name
- # smtpServer: smtp server address
- # smtpUser: smtp user on the server
- # smtpPort: Port of smtp server
- # password: Password for smtp server
- # sender: sender email address
- (
- String!, :
- String!, :
- String!, :
- Int!, :
- String, :
- String! :
- ): SMTPServer!
- # Update SMTP server
- #
- # Arguments
- # id: ID
- # name: Name
- # smtpServer: smtp server address
- # smtpUser: smtp user on the server
- # smtpPort: Port of smtp server
- # password: Password for smtp server
- # sender: sender email address
- (
- ID!, :
- String!, :
- String!, :
- String!, :
- Int!, :
- String, :
- String! :
- ): SMTPServer!
- # Archive SMTP server
- #
- # Arguments
- # id: [Not documented]
- ID!): SMTPServer! ( :
- # Test an existing SMTP server
- #
- # Arguments
- # id: ID
- # recipient: Recipient
- ID!, : String!): Job! ( :
- # Test ad hoc SMTP server
- #
- # Arguments
- # name: Name
- # password: Password for smtp server
- # smtpServer: smtp server address
- # smtpUser: smtp user on the server
- # smtpPort: Port of smtp server
- # sender: sender email address
- # recipient: sender email address
- (
- String!, :
- String, :
- String!, :
- String!, :
- Int!, :
- String!, :
- String! :
- ): Job!
- # Create FortiGate server
- #
- # Arguments
- # name: Name of FortiGate server
- # apiKey: API key of FortiGate server
- # address: Address of FortiGate server, including http/s and port
- # if needed
- # enablePolicy: Whether or not to enable the new policy on
- # FortiGate
- (
- String!, :
- String!, :
- String!, :
- Boolean! :
- ): FortiGateServer!
- # Update FortiGate server
- #
- # Arguments
- # id: ID
- # name: Name of FortiGate server
- # apiKey: API key of FortiGate server
- # address: Address of FortiGate server, including http/s and port
- # if needed
- # enablePolicy: Whether or not to enable the new policy on
- # FortiGate
- (
- ID!, :
- String!, :
- String, :
- String!, :
- Boolean! :
- ): FortiGateServer!
- # Archive FortiGate server
- #
- # Arguments
- # id: [Not documented]
- ID!): FortiGateServer! ( :
- # Test an existing FortiGate server
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test ad hoc FortiGate server
- #
- # Arguments
- # name: Name of FortiGate server
- # apiKey: API key of FortiGate server
- # address: Address of FortiGate server, including http/s and port
- # if needed
- (
- String!, :
- String!, :
- String! :
- ): Job!
- # New Palo Alto server
- #
- # Arguments
- # hostname: Hostname
- # username: Username
- # password: Password
- (
- String!, :
- String!, :
- String! :
- ): PaloAltoServer!
- # Update Palo Alto server
- #
- # Arguments
- # id: ID
- # hostname: Hostname
- # username: Username
- # password: Password
- (
- ID!, :
- String!, :
- String!, :
- String! :
- ): PaloAltoServer!
- # Delete Palo Alto server
- #
- # Arguments
- # id: [Not documented]
- ID!): PaloAltoServer! ( :
- # New Aruba server
- #
- # Arguments
- # hostname: Hostname
- # username: Username
- # password: Password
- # client: API client
- # clientSecret: API client secret
- (
- String!, :
- String!, :
- String!, :
- String!, :
- String! :
- ): ArubaServer!
- # Update Aruba server
- #
- # Arguments
- # id: ID
- # hostname: Hostname
- # username: Username
- # password: Password
- # client: API client
- # clientSecret: API client secret
- (
- ID!, :
- String!, :
- String!, :
- String!, :
- String!, :
- String! :
- ): ArubaServer!
- # Delete Aruba server
- #
- # Arguments
- # id: [Not documented]
- ID!): ArubaServer! ( :
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- # snapshot: Should take snapshot
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- ActivityPolicyEvent!, :
- Group!, :
- Boolean! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- # snapshot: Should take snapshot
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- ActivityPolicyEvent!, :
- Group!, :
- Boolean! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # schedule: Schedule Group
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- AssetPolicyEvent!, :
- Group! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # schedule: Schedule Group
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- AssetPolicyEvent!, :
- Group! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- # protocolGroup: Protocol Group
- # snapshot: Should take snapshot
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- ProtocolPolicyEvent!, :
- Group!, :
- Group!, :
- Boolean :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- # protocolGroup: Protocol Group
- # snapshot: Should take snapshot
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- ProtocolPolicyEvent!, :
- Group!, :
- Group!, :
- Boolean :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # portGroup: Port Group
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- PortPolicyEvent!, :
- Group! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # event: Event type
- # portGroup: Port Group
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- PortPolicyEvent!, :
- Group! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- IDSSrcDstEvent!, :
- Group! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # event: Event type
- # schedule: Schedule Group
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- Group!]!]!, : [[
- Group!]!]!, : [[
- IDSSrcDstEvent!, :
- Group! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- IDSGeneralNewEvent!, :
- Group! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- IDSGeneralNewEvent!, :
- Group! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- # params: Extra Params
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- SpikeEvent!, :
- Group!, :
- SpikeDefParam! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- # params: Extra Params
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- SpikeEvent!, :
- Group!, :
- SpikeDefParam! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- # srcAssetGroup: Source Asset Group
- # params: Extra Params
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- RediscoveredAssetEvent!, :
- Group!, :
- Group!]!]!, : [[
- RediscoveredAssetParams! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # schedule: Schedule Group
- # srcAssetGroup: Source Asset Group
- # params: Extra Params
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- RediscoveredAssetEvent!, :
- Group!, :
- Group!]!]!, : [[
- RediscoveredAssetParams! :
- ): Policy!
- # New Policy
- #
- # Arguments
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # ruleGroup: Rule Group
- # schedule: Schedule Group
- (
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- IntrusionPolicyEvent!, :
- Group!]!]!, : [[
- Group!]!]!, : [[
- Group!, :
- Group! :
- ): Policy!
- # Update Policy
- #
- # Arguments
- # id: ID
- # title: Title
- # level: Level of policy
- # disableAfterHit: Should the policy be disabled after first hit
- # continuous: Indicates if the policy hits on continuous events
- # actions: Actions for policy
- # event: Event type
- # srcAssetGroup: Source Asset Group
- # dstAssetGroup: Destination Asset Group
- # ruleGroup: Rule Group
- # schedule: Schedule Group
- (
- ID!, :
- String!, :
- PolicyLevel!, :
- Boolean, :
- Boolean, :
- ActionParams!]!, : [
- IntrusionPolicyEvent!, :
- Group!]!]!, : [[
- Group!]!]!, : [[
- Group!, :
- Group! :
- ): Policy!
- # Archive a policy
- #
- # Arguments
- # id: [Not documented]
- ID!): Policy! ( :
- # Disable a policy
- #
- # Arguments
- # id: [Not documented]
- ID!): Policy! ( :
- # Enable a policy
- #
- # Arguments
- # id: [Not documented]
- ID!): Policy! ( :
- # Enable bulk of policies
- #
- # Arguments
- # ids: [Not documented]
- ID!]!): [Policy!]! ( : [
- # Disable bulk of policies
- #
- # Arguments
- # ids: [Not documented]
- ID!]!): [Policy!]! ( : [
- # Archive a bulk of policies
- #
- # Arguments
- # ids: [Not documented]
- ID!]!): [Policy!]! ( : [
- # Edit bulk of policies
- #
- # Arguments
- # ids: Policy IDs
- # level: New policies level
- # syslogActions: List of syslog servers IDs, use empty list to
- # delete all actions. null to ignore field
- # emailActions: List of email groups IDs, use empty list to
- # delete all actions. null to ignore field
- (
- ID!]!, : [
- PolicyLevel, :
- ID!], : [
- ID!] : [
- ): [Policy!]!
- # New email group
- #
- # Arguments
- # name: Name
- # server: Server ID
- # recipients: Recipients
- String!, : ID!, : [String!]!): EmailGroup! ( :
- # Update email group
- #
- # Arguments
- # id: ID
- # name: Name
- # server: Server ID
- # recipients: Recipients
- ID!, : String!, : ID!, : [String!]!): EmailGroup! ( :
- # Archive a email group
- #
- # Arguments
- # id: [Not documented]
- ID!): EmailGroup! ( :
- # Stop ongoing captures
- Job! :
- # Play the specified pcaps
- #
- # Arguments
- # ids: List of file ids to play
- # speed: The play speed (multiplication)
- String!]!, : Int): Job! ( : [
- # Delete a pcap file from the pcap player repository
- #
- # Arguments
- # id: [Not documented]
- ID!): PcapPlayerFileDetails! ( :
- # add a custom field
- #
- # Arguments
- # userDefinedName: [Not documented]
- # valueType: [Not documented]
- (
- String!, :
- CustomFieldValueType! :
- ): CustomField!
- # update a custom field
- #
- # Arguments
- # fieldId: [Not documented]
- # userDefinedName: [Not documented]
- # valueType: [Not documented]
- (
- String!, :
- String!, :
- CustomFieldValueType! :
- ): CustomField!
- # remove a custom field
- #
- # Arguments
- # fieldId: [Not documented]
- String!): CustomField! ( :
- # set the baseline: links since a given time
- #
- # Arguments
- # from: [Not documented]
- Time): Baseline! ( :
- # delete the baseline
- Baseline! :
- # Trigger an online nessus plugin set update
- Job! :
- # Trigger an online Suricata rule set update
- UpdateResult! :
- # Trigger an online dfe update
- DfeInfo! :
- # Add EM pairing API key configuration and start pairing
- #
- # Arguments
- # emAddress: EM Hostname/IP
- # certificateFingerprint: Optional certificate fingerprint for
- # validation with EM certificate
- # apiKey: Pairing EM API key (null to keep existing api key)
- (
- String!, :
- String, :
- String :
- ): IcpEmPairingStatusInfo!
- # Add EM pairing credentials configuration and start pairing
- #
- # Arguments
- # emAddress: EM Hostname/IP
- # certificateFingerprint: Optional certificate fingerprint for
- # validation with EM certificate
- # username: Pairing EM username
- # password: Pairing EM password (null to keep existing password)
- (
- String!, :
- String, :
- String!, :
- String :
- ): IcpEmPairingStatusInfo!
- # Delete EM pairing configuration and stop pairing/tunnel
- IcpEmPairingStatusInfo! :
- # Approve EM pairing certificate manually
- IcpEmPairingStatusInfo! :
- # Create an exclusion for Intrusion Detection event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # sid: suricata's SID
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- (
- ID!, :
- String, :
- Float, :
- ID!], : [
- String, :
- ID!], : [
- String :
- ): Exclusion!
- # Create an exclusion for Activity event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- ID!], : [
- String :
- ): Exclusion!
- # Create an exclusion for Conversation event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- # protocol: [Not documented]
- # port: [Not documented]
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- ID!], : [
- String, :
- ProtocolType, :
- Int :
- ): Exclusion!
- # Create an exclusion for Ip Conflict event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # ip: [Not documented]
- # macs: The set of MACs to exclude.
- # The event's conflicting mac should be contained in this set.
- # MAC string format is with a ':' separator between bytes.
- (
- ID!, :
- String, :
- String, :
- String!] : [
- ): Exclusion!
- # Create an exclusion for Tag Write event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- # tag: tag name
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- ID!], : [
- String, :
- String :
- ): Exclusion!
- # Create an exclusion for Asset event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # assets: The list of asset IDs
- ID!, : String, : [ID!]): Exclusion! ( :
- # Create an exclusion for Scan event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # assets: The list of asset IDs
- # ip: [Not documented]
- (
- ID!, :
- String, :
- ID!], : [
- String :
- ): Exclusion!
- # Create an exclusion for Open Port event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # assets: The list of asset IDs
- # ip: [Not documented]
- # port: [Not documented]
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- Int :
- ): Exclusion!
- # Create an exclusion for Usb Change event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # assets: The list of asset IDs
- # usbDevice: Device Id
- (
- ID!, :
- String, :
- ID!], : [
- String :
- ): Exclusion!
- # Create an exclusion for IEC104 event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- # cot: [Not documented]
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- ID!], : [
- String, :
- String :
- ): Exclusion!
- # Create an exclusion for DNP3 event
- #
- # Arguments
- # policyId: [Not documented]
- # comment: [Not documented]
- # srcAssets: The list of src assets IDs
- # srcIp: [Not documented]
- # dstAssets: The list of dst assets IDs
- # dstIp: [Not documented]
- # srcDnp3Address: uint16 value
- # dstDnp3Address: uint16 value
- (
- ID!, :
- String, :
- ID!], : [
- String, :
- ID!], : [
- String, :
- Int, :
- Int :
- ): Exclusion!
- # Delete an exclusion rule
- #
- # Arguments
- # policyId: [Not documented]
- # exclusionId: [Not documented]
- ID!, : String!): Exclusion! ( :
- # Recalculate risk score for asset
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Recalculate risk score for all assets
- #
- # Arguments
- # components: List of component to recalculate, empty or empty
- # list will recalculate all
- ComponentType!]): Job! ( : [
- # Add tenable.one server
- #
- # Arguments
- # name: Name for the tenable.one server
- # linkingKey: One-time use linking key, generated from Tenable
- # One OT Connectors page
- # cloudSite: Cloud Site
- String!, : String!, : String!): OneServer! ( :
- # Update tenable.one server
- #
- # Arguments
- # name: Name for the tenable.one server
- # id: ID
- String!, : ID!): OneServer! ( :
- # Archive tenable.one server
- #
- # Arguments
- # id: [Not documented]
- ID!): OneServer! ( :
- # Add new blocking firewall rule
- #
- # Arguments
- # op: Empty value means all supported Ops
- # target: IP/CIDR to block
- FirewallOpType, : String!): FirewallRule! ( :
- # Delete existing blocking firewall rule
- #
- # Arguments
- # op: Empty value means all supported Ops
- # target: IP/CIDR to block
- FirewallOpType, : String!): FirewallRule! ( :
- # Add user group
- #
- # Arguments
- # name: Name for the user group
- # roles: list of roles to set
- # users: list of users to set
- # providersMapping: List of mapped auth providers to external
- # groups
- # zones: list of zones to assign the user group to
- (
- String!, :
- String!]!, : [
- String], : [
- GroupProviderParams!], : [
- String!] : [
- ): UserGroup!
- # Edit user group
- #
- # Arguments
- # id: User group id
- # name: Name for the user group
- # roles: list of roles to set
- # users: list of users to set
- # providersMapping: List of mapped auth providers to external
- # groups
- # zones: list of zones to assign the user group to
- (
- ID!, :
- String!, :
- String!]!, : [
- String], : [
- GroupProviderParams!], : [
- String!] : [
- ): UserGroup!
- # Archive user group
- #
- # Arguments
- # id: [Not documented]
- ID!): UserGroup! ( :
- # Add new basic credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # username: Username for basic credentials schema
- # type: Credentials type for basic credentials schema
- # password: Password for basic credentials schema
- (
- String!, :
- String, :
- String!, :
- BasicCredentialsTypes!, :
- String! :
- ): Credentials!
- # Add new password only credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # password: Password for password only credentials schema (null
- # to keep existing password)
- # type: Credentials type for password only credentials schema
- (
- String!, :
- String, :
- String!, :
- PasswordOnlyCredentialsTypes! :
- ): Credentials!
- # Add new SNMP V2 credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # type: Credentials type for SNMP-V2 credentials schema
- # communityStrings: Community strings for SNMP-V2 credentials
- # schema
- (
- String!, :
- String, :
- SnmpV2CredentialsTypes!, :
- String!]! : [
- ): Credentials!
- # Add new SNMP V3 credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # type: Credentials type for SNMP-V3 credentials schema
- # username: Username for SNMP-V3 credentials schema
- # securityLevel: Security Level for SNMP-V3 credentials schema
- # authPassword: Auth Password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # authProtocol: Auth Protocol for SNMP-V3 credentials schema
- # privPassword: Priv password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # privProtocol: Priv Protocol for SNMP-V3 credentials schema
- # securityEngineId: Security engine ID for SNMP-V3 credentials
- # schema
- # contextEngineId: Context Engine ID for SNMP-V3 credentials
- # schema
- # contextName: Context name for SNMP-V3 credentials schema
- (
- String!, :
- String, :
- SnmpV3CredentialsTypes!, :
- String!, :
- SnmpV3SecurityLevel!, :
- String, :
- SnmpV3AuthProtocol, :
- String, :
- SnmpV3PrivProtocol, :
- String, :
- String, :
- String :
- ): Credentials!
- # Update basic credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # username: Username for basic credentials schema
- # id: ID
- # password: Password for basic credentials schema (null to keep
- # existing password)
- (
- String!, :
- String, :
- String!, :
- ID!, :
- String :
- ): Credentials!
- # Update password only credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # id: ID for password only credentials schema
- # password: Password for password only credentials schema (null
- # to keep existing password)
- (
- String!, :
- String, :
- ID!, :
- String :
- ): Credentials!
- # Update SNMP V2 credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # id: ID
- # communityStrings: Community strings for SNMP-V2 credentials
- # schema
- (
- String!, :
- String, :
- ID!, :
- String!]! : [
- ): Credentials!
- # Update SNMP V3 credentials
- #
- # Arguments
- # name: Credentials name
- # description: Credentials description
- # id: ID for SNMP-V3 credentials schema
- # username: Username for SNMP-V3 credentials schema
- # securityLevel: Security Level for SNMP-V3 credentials schema
- # authPassword: Auth Password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # authProtocol: Auth Protocol for SNMP-V3 credentials schema
- # privPassword: Priv password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # privProtocol: Priv Protocol for SNMP-V3 credentials schema
- # securityEngineId: Security engine ID for SNMP-V3 credentials
- # schema
- # contextEngineId: Context Engine ID for SNMP-V3 credentials
- # schema
- # contextName: Context name for SNMP-V3 credentials schema
- (
- String!, :
- String, :
- ID!, :
- String!, :
- SnmpV3SecurityLevel!, :
- String, :
- SnmpV3AuthProtocol, :
- String, :
- SnmpV3PrivProtocol, :
- String, :
- String, :
- String :
- ): Credentials!
- # Delete credentials
- #
- # Arguments
- # id: [Not documented]
- ID!): Credentials! ( :
- # Test ad hoc basic credentials
- #
- # Arguments
- # ip: Address to test the credentials on
- # type: Credentials type for basic credentials schema
- # username: Username to test for basic credentials schema
- # password: Password to test for basic credentials schema
- (
- String!, :
- BasicCredentialsTypes!, :
- String!, :
- String! :
- ): Job!
- # Test ad hoc password only credentials
- #
- # Arguments
- # ip: Address to test the credentials on
- # type: Credentials type for password only credentials schema
- # password: Password to test for password only credentials schema
- (
- String!, :
- PasswordOnlyCredentialsTypes!, :
- String! :
- ): Job!
- # Test ad hoc SNMP V2 credentials
- #
- # Arguments
- # ip: Address to test the credentials on
- # type: Credentials type for SNMP-V2 credentials schema
- # communityStrings: Community strings to test for SNMP-V2
- # credentials schema
- (
- String!, :
- SnmpV2CredentialsTypes!, :
- String!]! : [
- ): Job!
- # Test ad hoc SNMP V3 credentials
- #
- # Arguments
- # ip: Address to test the credentials on
- # type: Credentials type to test for SNMP-V3 credentials schema
- # username: Username for SNMP-V3 credentials schema
- # securityLevel: Security Level for SNMP-V3 credentials schema
- # authPassword: Auth Password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # authProtocol: Auth Protocol for SNMP-V3 credentials schema
- # privPassword: Priv password for SNMP-V3 credentials schema
- # (null to keep existing password)
- # privProtocol: Priv Protocol for SNMP-V3 credentials schema
- # securityEngineId: Security engine ID for SNMP-V3 credentials
- # schema
- # contextEngineId: Context Engine ID for SNMP-V3 credentials
- # schema
- # contextName: Context name for SNMP-V3 credentials schema
- (
- String!, :
- SnmpV3CredentialsTypes!, :
- String!, :
- SnmpV3SecurityLevel!, :
- String, :
- SnmpV3AuthProtocol, :
- String, :
- SnmpV3PrivProtocol, :
- String, :
- String, :
- String :
- ): Job!
- # Test existing credentials
- #
- # Arguments
- # id: Credentials ID
- # ip: Address to test the credentials on
- ID!, : String!): Job! ( :
- # Set addresses of assets to delete
- #
- # Arguments
- # addresses: [Not documented]
- String!]!): AddressesPendingDeletion! ( : [
- # Activate license
- #
- # Arguments
- # activationBlob: [Not documented]
- String!): LicenseInfo! ( :
- # Bulk set plugins details
- #
- # Arguments
- # plugins: Plugin ID's to update
- # comment: Comment
- # owner: Owner
- Int!]!, : String, : String): [Plugin!]! ( : [
- # Delete and unpair a sensor
- #
- # Arguments
- # id: [Not documented]
- ID!): SensorDetails! ( :
- # Pause sensor traffic, keep pairing
- #
- # Arguments
- # id: [Not documented]
- ID!): SensorDetails! ( :
- # Resume paired sensor traffic
- #
- # Arguments
- # id: [Not documented]
- ID!): SensorDetails! ( :
- # Approve sensor for pairing
- #
- # Arguments
- # id: [Not documented]
- ID!): SensorDetails! ( :
- # Edit sensor
- #
- # Arguments
- # id: Sensor ID
- # name: Sensor name
- # active: Allow the sensor to do active queries
- # activeNetworks: Networks the sensor is active on
- (
- String!, :
- String, :
- Boolean, :
- String!] : [
- ): SensorDetails!
- # Bulk update sensors
- #
- # Arguments
- # ids: [Not documented]
- ID!]!): Job! ( : [
- # Check for all sensors updates
- Job! :
- # Create a new user scan
- #
- # Arguments
- # name: User scan name
- # plugins: User scan plugins
- # cidrs: User scan CIDRs
- (
- String!, :
- PluginFamilyArgs!]!, : [
- String!]! : [
- ): Job!
- # Edit a user scan
- #
- # Arguments
- # id: User scan ID
- # name: User scan name
- # plugins: User scan plugins
- # cidrs: User scan CIDRs
- (
- Int!, :
- String!, :
- PluginFamilyArgs!]!, : [
- String!]! : [
- ): Job!
- # Delete a user scan
- #
- # Arguments
- # id: [Not documented]
- Int!): Job! ( :
- # Perform user scan action (run / pause / resume / stop / kill)
- #
- # Arguments
- # id: User scan ID
- # action: Action to perform
- # force: Force nessus user scan action
- (
- Int!, :
- ScanAction!, :
- Boolean :
- ): Job!
- # Run active query
- #
- # Arguments
- # queryId: Query ID
- # assetId: Asset Id to be executed
- # considerPrevStats: Allow query execution regardless of previous
- # stats
- # force: Force query execution when query disabled or during
- # blackout period
- # additionalParams: Additional params for active query execution
- (
- ID!, :
- ID, :
- Boolean, :
- Boolean, :
- ActiveQueriesExecuteSpecialParam :
- ): Job!
- # Can run active query
- #
- # Arguments
- # queryId: Query ID
- # assetId: Asset Id to be executed
- # trace: WARNING: Increases execution time and retrieves trace
- # results of applying active clients rules on the provided target
- ID!, : ID!, : Boolean): CanExecute! ( :
- # Stop active query
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Create active query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # operation: Operation type
- # assetGroup: Target asset group
- # schedule: Query schedule
- (
- String!, :
- String, :
- Boolean!, :
- OpType!, :
- ID!, :
- ScheduleParams!] : [
- ): ActiveQuery!
- # Edit active query
- #
- # Arguments
- # id: Query ID
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # assetGroup: Target asset group
- # schedule: Query schedule
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ID!, :
- ScheduleParams!] : [
- ): ActiveQuery!
- # Delete active query
- #
- # Arguments
- # id: [Not documented]
- ID!): ActiveQuery! ( :
- # Create controller discovery query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- (
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!] : [
- ): ActiveQuery!
- # Edit controller discovery query
- #
- # Arguments
- # id: Query ID
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!] : [
- ): ActiveQuery!
- # Create asset discovery query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- # options: Asset Discovery options
- (
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- AssetDiscoveryOptionsParams! :
- ): ActiveQuery!
- # Edit asset discovery query
- #
- # Arguments
- # id: ID
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- # options: Asset Discovery options
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- AssetDiscoveryOptionsParams! :
- ): ActiveQuery!
- # Create inactive probing query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Inactive Probing options
- (
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- InactiveProbingOptionsParams! :
- ): ActiveQuery!
- # Edit inactive probing query
- #
- # Arguments
- # id: ID
- # name: Query name
- # description: Query description
- # enabled: Query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Inactive Probing options
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- InactiveProbingOptionsParams! :
- ): ActiveQuery!
- # Create port scan query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Is query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Query port scan options
- (
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- PortScanOptionsParams! :
- ): ActiveQuery!
- # Edit port scan query
- #
- # Arguments
- # id: ID
- # name: Query name
- # description: Query description
- # enabled: Is query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Query port scan options
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- PortScanOptionsParams! :
- ): ActiveQuery!
- # Create snmp query
- #
- # Arguments
- # name: Query name
- # description: Query description
- # enabled: Is query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Query snmp options
- (
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- SnmpOptionsParams! :
- ): ActiveQuery!
- # Edit snmp query
- #
- # Arguments
- # id: ID
- # name: Query name
- # description: Query description
- # enabled: Is query enabled
- # schedule: Query schedule
- # assetGroup: Target asset group
- # options: Query snmp options
- (
- ID!, :
- String!, :
- String, :
- Boolean!, :
- ScheduleParams!], : [
- ID!, :
- SnmpOptionsParams! :
- ): ActiveQuery!
- # Enable active query
- #
- # Arguments
- # id: [Not documented]
- ID!): ActiveQuery! ( :
- # Disable active query
- #
- # Arguments
- # id: [Not documented]
- ID!): ActiveQuery! ( :
- # Set active queries global enablement
- #
- # Arguments
- # enabled: [Not documented]
- (
- Boolean! :
- ): ActiveQueriesGlobalConfigs!
- # Disable blackout period
- FlagList! :
- # Create Zone
- #
- # Arguments
- # name: Zone name
- # description: Zone description
- # assetGroups: Asset groups belonging to the zone
- # userGroups: User groups assigned to the zone
- (
- String!, :
- String, :
- ID!]!, : [
- ID!] : [
- ): Zone!
- # Archive Zone
- #
- # Arguments
- # id: [Not documented]
- ID!): Zone! ( :
- # Update Zone
- #
- # Arguments
- # id: ID
- # name: Zone name
- # description: Zone description
- # assetGroups: Asset groups belonging to the zone
- # userGroups: User groups assigned to the zone
- (
- ID!, :
- String!, :
- String, :
- ID!]!, : [
- ID!] : [
- ): Zone!
- # Set active queries global configs
- #
- # Arguments
- # enabled: Are active queries enabled
- # blackoutPeriod: Blackout period
- # blacklistedAssetGroups: Blacklist asset group
- # clientGroups: Blacklist clients
- (
- Boolean!, :
- ID, :
- ID!], : [
- RestrictedProtocolType!] : [
- ): ActiveQueriesGlobalConfigs!
- # Create asset report
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Create a report for a bulk of assets
- #
- # Arguments
- # filter: [Not documented]
- # search: [Not documented]
- # sort: [Not documented]
- # slowCount: When requesting totalCount set this to true to wait
- # for count query to complete.
- # Otherwise, countTimeout is used to limit the execution time, resulting in -1
- # when limit is reached.
- # countTimeout: Time (in milliseconds) to wait for count query to
- # return.
- # Only applicable when slowCount is not set.
- (
- AssetExpressionsParams, :
- String, :
- AssetSortParams!], : [
- Boolean, :
- Int :
- ): Job!
- # Export active query last execution CSV report
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Add Agent IoT Connector
- #
- # Arguments
- # name: Connector name
- # ip: Connector IP
- String!, : String!): AgentConnector! ( :
- # Add Exacq IoT Connector
- #
- # Arguments
- # name: Connector name
- # ip: Connector IP
- # options: [Not documented]
- (
- String!, :
- String!, :
- ExacqAddOptionsParams! :
- ): ExacqConnector!
- # Add Milestone IoT Connector
- #
- # Arguments
- # name: Connector name
- # ip: Connector IP
- # options: [Not documented]
- (
- String!, :
- String!, :
- MilestoneAddOptionsParams! :
- ): MilestoneConnector!
- # Add Mobotix IoT Connector
- #
- # Arguments
- # name: Connector name
- # ip: Connector IP
- # options: [Not documented]
- (
- String!, :
- String!, :
- MobotixAddOptionsParams! :
- ): MobotixConnector!
- # Edit Agent IoT Connector
- #
- # Arguments
- # name: Connector name
- # id: [Not documented]
- String!, : ID!): AgentConnector! ( :
- # Edit Exacq IoT Connector
- #
- # Arguments
- # name: Connector name
- # id: [Not documented]
- # options: [Not documented]
- (
- String!, :
- ID!, :
- ExacqEditOptionsParams! :
- ): ExacqConnector!
- # Edit Milestone IoT Connector
- #
- # Arguments
- # name: Connector name
- # id: [Not documented]
- # options: [Not documented]
- (
- String!, :
- ID!, :
- MilestoneEditOptionsParams! :
- ): MilestoneConnector!
- # Edit Mobotix IoT Connector
- #
- # Arguments
- # name: Connector name
- # id: [Not documented]
- # options: [Not documented]
- (
- String!, :
- ID!, :
- MobotixEditOptionsParams! :
- ): MobotixConnector!
- # Test Agent IoT Connector
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Delete IoT Connector
- #
- # Arguments
- # id: [Not documented]
- ID!): IotConnectorInfo! ( :
- # Add EM user
- #
- # Arguments
- # fullName: [Not documented]
- # userName: [Not documented]
- # groups: [Not documented]
- # password: [Not documented]
- (
- String!, :
- String!, :
- ID!]!, : [
- String! :
- ): EmUser!
- # Change EM user details
- #
- # Arguments
- # userName: The username that performs the operation
- # fullName: Requested full user name
- String, : String): EmUser! ( :
- # Change EM user password
- #
- # Arguments
- # newPassword: New Password
- # password: Current password
- # userName: The username that performs the operation
- String, : String, : String): EmUser! ( :
- # Set EM user's groups
- #
- # Arguments
- # userName: The username to set the group for
- # newGroups: [Not documented]
- String, : [ID!]!): EmUser! ( :
- # Deletes the EM user
- #
- # Arguments
- # userName: [Not documented]
- String!): EmUser! ( :
- # Sets password of a EM user (by admin only)
- #
- # Arguments
- # password: New Password
- # userName: The username to set password for
- String!, : String!): EmUser! ( :
- # Set the system time, this will result in a system restart
- #
- # Arguments
- # time: Time in RFC3339
- # location: System location as defined in TZData
- String, : String): EmSystemInfo! ( :
- # Approve ICP for pairing on the EM
- #
- # Arguments
- # id: [Not documented]
- ID!): PairedIcp! ( :
- # Delete ICP pairing on the EM
- #
- # Arguments
- # id: [Not documented]
- ID!): PairedIcp! ( :
- # Add EM user group
- #
- # Arguments
- # name: Name for the user group
- # roles: list of roles to set
- # users: list of users to set
- # providersMapping: List of mapped auth providers to external
- # groups
- # zones: list of zones to assign the user group to
- # emLevel: If the group is an EM group or ICP group
- (
- String!, :
- String!]!, : [
- String], : [
- GroupProviderParams!], : [
- String!], : [
- Boolean! :
- ): EmUserGroup!
- # Edit EM user group
- #
- # Arguments
- # id: User group id
- # name: Name for the user group
- # roles: list of roles to set
- # users: list of users to set
- # providersMapping: List of mapped auth providers to external
- # groups
- # zones: list of zones to assign the user group to
- (
- ID!, :
- String!, :
- String!]!, : [
- String], : [
- GroupProviderParams!], : [
- String!] : [
- ): EmUserGroup!
- # Archive EM user group
- #
- # Arguments
- # id: [Not documented]
- ID!): EmUserGroup! ( :
- # Activate license
- #
- # Arguments
- # activationBlob: [Not documented]
- String!): EmLicenseInfo! ( :
- # Update ICPs (bulk)
- #
- # Arguments
- # type: update type
- # icpIds: list of icp ids to update
- IcpEmUpdateType, : [String]): Job! ( :
- # Store an item with key in the storage
- #
- # Arguments
- # key: [Not documented]
- # value: [Not documented]
- String!, : String!): Storage! ( :
- # Store an item globally with key in the storage
- #
- # Arguments
- # key: [Not documented]
- # value: [Not documented]
- String!, : String!): Storage! ( :
- # Enable or disable the system
- #
- # Arguments
- # enabled: [Not documented]
- Boolean!): Job! ( :
- # Shutdown or Reboots the system
- #
- # Arguments
- # type: [Not documented]
- SystemShutdownType!): Job! ( :
- # Performs initialization of the system
- #
- # Arguments
- # fullName: [Not documented]
- # userName: [Not documented]
- # password: [Not documented]
- # time: Time in RFC3339
- # location: System location as defined in TZData
- # config: [Not documented]
- # reboot: [Not documented]
- (
- String!, :
- String!, :
- String!, :
- String, :
- String, :
- JSON, :
- Boolean! :
- ): Job!
- # Change the configuration of the system
- #
- # Arguments
- # CharacteristicsInterval: [Not documented]
- # NameQueryInterval: [Not documented]
- # PortScanEnabled: [Not documented]
- # RunStatusInterval: [Not documented]
- # SnapshotInterval: [Not documented]
- # CaptureEnabled: [Not documented]
- # SelfSniffEnabled: [Not documented]
- # SensorsAutoApprove: [Not documented]
- # UIHosts: [Not documented]
- # AutoLogoutDurationInSeconds: [Not documented]
- # EnableClassificationBanner: [Not documented]
- # UiClassificationBannerText: [Not documented]
- # UiClassificationBannerColor: [Not documented]
- (
- ScheduleParams!], : [
- ScheduleParams!], : [
- Boolean, :
- ScheduleParams!], : [
- ScheduleParams!], : [
- Boolean, :
- Boolean, :
- Boolean, :
- String!], : [
- Int, :
- Boolean, :
- String, :
- ClassificationBannerColor :
- ): Config!
- # Performs system factory reset
- #
- # Arguments
- # keepNetworkConfig: Should keep the network configuration or
- # reset it
- Boolean!): Job! ( :
- # Set Syslog server
- #
- # Arguments
- # name: Name
- # protocol: Protocol of syslog server
- # address: Address of syslog server
- # port: Port of syslog server
- # keepAlive: Is keep alive message enabled
- # caching: Flag for caching
- (
- String!, :
- String!, :
- String!, :
- Int!, :
- Boolean, :
- Boolean :
- ): SyslogServer!
- # Update Syslog server
- #
- # Arguments
- # id: ID
- # name: Name
- # protocol: Protocol of syslog server
- # address: Address of syslog server
- # port: Port of syslog server
- # keepAlive: Is keep alive message enabled
- # caching: Flag for caching
- (
- ID!, :
- String!, :
- String!, :
- String!, :
- Int!, :
- Boolean, :
- Boolean :
- ): SyslogServer!
- # Archive Syslog server
- #
- # Arguments
- # id: [Not documented]
- ID!): SyslogServer! ( :
- # Test an existing Syslog server
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test ad hoc Syslog server
- #
- # Arguments
- # name: Name
- # protocol: Protocol of syslog server
- # address: Address of syslog server
- # port: Port of syslog server
- # keepAlive: Is keep alive message enabled
- # caching: Flag for caching
- (
- String!, :
- String!, :
- String!, :
- Int!, :
- Boolean, :
- Boolean :
- ): Job!
- # Remove flags
- #
- # Arguments
- # flag: [Not documented]
- RemovableFlags!): FlagList! ( :
- # Change tubbigy log level
- #
- # Arguments
- # level: [Not documented]
- LogLevel!): LogLevel! ( :
- # Create a new API Key for the current user
- #
- # Arguments
- # description: [Not documented]
- # expiryTime: [Not documented]
- String!, : Time!): APIKeyResponse! ( :
- # Delete an existing API Key
- #
- # Arguments
- # id: [Not documented]
- Float!): APIKey! ( :
- # Add tenable.sc server
- #
- # Arguments
- # address: Address of tenable.sc server, including http/s and
- # port if needed
- # user: Username in tenable.sc for the integration
- # password: Password of the given username
- # name: Name of tenable.sc server
- # repoId: The repository in tenable.sc to associate the agent
- # with
- # schedule: Schedule for syncing with the tenable.sc server. If
- # empty or invalid a default schedule will be used
- (
- String!, :
- String!, :
- String!, :
- String!, :
- Int!, :
- ScheduleParams! :
- ): ScServer!
- # Update tenable.sc server
- #
- # Arguments
- # address: Address of tenable.sc server, including http/s and
- # port if needed
- # user: Username in tenable.sc for the integration
- # password: Password of the given username
- # name: Name of tenable.sc server
- # repoId: The repository in tenable.sc to associate the agent
- # with
- # schedule: Schedule for syncing with the tenable.sc server. If
- # empty or invalid a default schedule will be used
- # id: ID
- (
- String!, :
- String!, :
- String, :
- String!, :
- Int!, :
- ScheduleParams!, :
- ID! :
- ): ScServer!
- # Archive tenable.sc server
- #
- # Arguments
- # id: [Not documented]
- ID!): ScServer! ( :
- # Sync Tenable.ot to Tenable.sc now
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test an existing tenable.sc server
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test ad hoc tenable.sc server
- #
- # Arguments
- # address: Address of tenable.sc server, including http/s and
- # port if needed
- # user: Username in tenable.sc for the integration
- # password: Password of the given username
- (
- String!, :
- String!, :
- String! :
- ): Job!
- # Add tenable.io server
- #
- # Arguments
- # accessKey: AccessKey property of API Keys
- # secretKey: SecretKey property of API Keys
- # name: Name for the tenable.io server
- # schedule: Schedule for syncing with the tenable.io server. If
- # empty or invalid a default schedule will be used
- (
- String!, :
- String!, :
- String!, :
- ScheduleParams! :
- ): IoServer!
- # Update tenable.io server
- #
- # Arguments
- # accessKey: AccessKey property of API Keys
- # secretKey: SecretKey property of API Keys
- # name: Name for the tenable.io server
- # schedule: Schedule for syncing with the tenable.io server. If
- # empty or invalid a default schedule will be used
- # id: ID
- (
- String, :
- String, :
- String!, :
- ScheduleParams!, :
- ID! :
- ): IoServer!
- # Archive tenable.io server
- #
- # Arguments
- # id: [Not documented]
- ID!): IoServer! ( :
- # Sync Tenable.ot to Tenable.io now
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test an existing tenable.io server
- #
- # Arguments
- # id: [Not documented]
- ID!): Job! ( :
- # Test ad hoc tenable.io server
- #
- # Arguments
- # accessKey: AccessKey property of API Keys
- # secretKey: SecretKey property of API Keys
- String!, : String!): Job! ( :
- # Add authentication provider
- #
- # Arguments
- # providerDetails: [Not documented]
- # groupsMapping: List of mapped external groups to Tenable.ot
- # groups
- (
- ProviderDetailsParams!, :
- ExternalGroupParams!] : [
- ): AuthProvider!
- # Edit authentication provider
- #
- # Arguments
- # providerDetails: [Not documented]
- # groupsMapping: List of mapped external groups to Tenable.ot
- # groups
- # id: [Not documented]
- (
- ProviderDetailsParams!, :
- ExternalGroupParams!], : [
- ID! :
- ): AuthProvider!
- # Delete authentication provider
- #
- # Arguments
- # id: [Not documented]
- ID!): AuthProvider! ( :
- # Enable authentication provider
- #
- # Arguments
- # id: [Not documented]
- ID!): AuthProvider! ( :
- # Disable authentication provider
- #
- # Arguments
- # id: [Not documented]
- ID!): AuthProvider! ( :
- # Upload a web server certificate
- #
- # Arguments
- # cert: PEM of certificate for HTTPS connection (can be
- # self-signed)
- # key: PEM of private key for cert
- # keyPassword: [Not documented]
- (
- String!, :
- String!, :
- String :
- ): Job!
- # Generate a self-signed web server certificate
- Job! :
- # Register a new activation code. This code receives a pending status until it's
- # being used to fully activate the license. This code does not replace the
- # existing license's code until the license is fully activated
- #
- # Arguments
- # activationCode: [Not documented]
- (
- String! :
- ): LicenseActivationRequest!
- # Remove the pending, previously registered activation code if one exists
- LicenseActivationCodeClearResponse! :
- # Generate license certificate
- LicenseActivationRequest! @deprecated( reason: "Generating a certificate was split to allow generation by using either a pending, registered activation code or the existing license's activation code. Please see generateLicenseActivationCertificate for more information" ) :
- # Generate a license activation certificate from either the pending activation
- # code or from the activation code of the already existing license
- #
- # Arguments
- # activationCodeSource: [Not documented]
- (
- ActivationCodeSource! :
- ): LicenseActivationRequest!
- }
link Require by
This element is not required by anyone