Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

startIntegrationInstallation

(platformType)

Arguments

platformType
PlatformType!,non-nullrequired

Return type

IntegrationInstallationResponse!
integration
Integration!,non-null
error
String
redirectUri
String
claudeCodeConfig
gitHubCopilotConfig
Mutation sample
mutation startIntegrationInstallation($platformType: PlatformType!) {
  startIntegrationInstallation(platformType: $platformType) {
    integration {
      __typename
      # ...IntegrationFragment
    }
    error 
    redirectUri 
    claudeCodeConfig {
      __typename
      # ...ClaudeCodeConfigFragment
    }
    gitHubCopilotConfig {
      __typename
      # ...GitHubCopilotConfigFragment
    }
  }
}
Variables
{ "platformType": "POWERPLATFORM" }
Response sample
{ "data": { "integration": { "__typename": "Integration" }, "error": "Example String", "redirectUri": "Example String", "claudeCodeConfig": { "__typename": "ClaudeCodeConfig" }, "gitHubCopilotConfig": { "__typename": "GitHubCopilotConfig" } } }

finishIntegrationInstallation

(installIntegrationInput)
Integration!,non-null

Arguments

installIntegrationInput
InstallIntegrationInput!,non-nullrequired

Return type

Integration!
platform
Platform!,non-null
status
description
String!,non-null
error
String
Mutation sample
mutation finishIntegrationInstallation($installIntegrationInput: InstallIntegrationInput!) {
  finishIntegrationInstallation(installIntegrationInput: $installIntegrationInput) {
    platform {
      __typename
      # ...PlatformFragment
    }
    status 
    description 
    error 
  }
}
Variables
{ "installIntegrationInput": { "platformType": "POWERPLATFORM", "code": "Example String", "state": "Example String", "roleArn": "Example String" } }
Response sample
{ "data": { "platform": { "__typename": "Platform" }, "status": "DISABLED", "description": "Example String", "error": "Example String" } }

updateIntegrationStatus

(...args)
Integration!,non-null

Arguments

platformType
PlatformType!,non-nullrequired
enabled
Boolean!,non-nullrequired

Return type

Integration!
platform
Platform!,non-null
status
description
String!,non-null
error
String
Mutation sample
mutation updateIntegrationStatus($platformType: PlatformType!, $enabled: Boolean!) {
  updateIntegrationStatus(platformType: $platformType, enabled: $enabled) {
    platform {
      __typename
      # ...PlatformFragment
    }
    status 
    description 
    error 
  }
}
Variables
{ "platformType": "POWERPLATFORM", "enabled": true }
Response sample
{ "data": { "platform": { "__typename": "Platform" }, "status": "DISABLED", "description": "Example String", "error": "Example String" } }

syncIntegration

(platformType)
Integration!,non-null

Arguments

platformType
PlatformType!,non-nullrequired

Return type

Integration!
platform
Platform!,non-null
status
description
String!,non-null
error
String
Mutation sample
mutation syncIntegration($platformType: PlatformType!) {
  syncIntegration(platformType: $platformType) {
    platform {
      __typename
      # ...PlatformFragment
    }
    status 
    description 
    error 
  }
}
Variables
{ "platformType": "POWERPLATFORM" }
Response sample
{ "data": { "platform": { "__typename": "Platform" }, "status": "DISABLED", "description": "Example String", "error": "Example String" } }

syncAgent

(agentId)
Agent!,non-null

Arguments

agentId
ID!,non-nullrequired

Return type

Agent!
externalId
ID!,non-null
id
ID!,non-null
platform
Platform!,non-null
name
String!,non-null
environment
Environment!,non-null
owner
Owner!,non-null
accessibility
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
highestIssueSeverity
usage
findings
[Finding!]!,non-null
detections
isRuntimeProtected
Boolean
Mutation sample
mutation syncAgent($agentId: ID!) {
  syncAgent(agentId: $agentId) {
    externalId 
    id 
    platform {
      __typename
      # ...PlatformFragment
    }
    name 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    accessibility 
    description 
    nodes {
      id 
      name 
    }
    edges {
      connectionA 
      connectionB 
      direction 
      type 
    }
    tools {
      __typename
      # ...ToolFragment
    }
    createdAt 
    updatedAt 
    highestIssueSeverity {
      __typename
      # ...IssueFragment
    }
    usage {
      __typename
      # ...UsageFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    detections {
      __typename
      # ...DetectionTypeAggregationFragment
    }
    isRuntimeProtected 
  }
}
Variables
{ "agentId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "platform": { "__typename": "Platform" }, "name": "Example String", "environment": { "__typename": "Environment" }, "owner": { "__typename": "Owner" }, "accessibility": "PUBLIC", "description": "Example String", "nodes": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String" } ], "edges": [ { "connectionA": "Example String", "connectionB": "Example String", "direction": "ATOB", "type": "NORMAL" } ], "tools": [ { "__typename": "Tool" } ], "createdAt": "Example Custom Scalar", "updatedAt": "Example Custom Scalar", "highestIssueSeverity": { "__typename": "Issue" }, "usage": { "__typename": "Usage" }, "findings": [ { "__typename": "Finding" } ], "detections": [ { "__typename": "DetectionTypeAggregation" } ], "isRuntimeProtected": true } }

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview