OBJECT
GuardrailsMutations

GraphQL Schema definition

type GuardrailsMutations {
#   Clone a guardrails template
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   meta: guardrails clone template input
cloneTemplate(meta: GuardrailsTemplateInput!): GuardrailsTemplate 
#   Create a cloud account.
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   input: Input parameters for creating onboarding and setting up 
#   event stream for the cloud account.
createCloudAccount(
input: GuardrailsCreateCloudAccountInput!
): GuardrailsCreateAccountResponse 
#   Delete Guardrails desired states
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   ids: [Not documented]
deleteDesiredStates(ids: [ID!]!): [GuardrailsDeleteResult!]! 
#   Delete Guardrails templates
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   ids: Ids of the guardrails templates to be deleted
deleteTemplates(ids: [ID!]!): [GuardrailsDeleteResult!]! 
#   Initiate template generation for an account
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   input: Guardrails generate template input
generateTemplate(input: GuardrailsGenerateTemplateInput!): GuardrailsGenerateTemplateResponse 
#   Import guardrails library templates
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   input: details of templates to be imported
importLibraryTemplates(
input: GuardrailsImportTemplateInput!
): GuardrailsImportLibraryTemplatesResponse 
#   Run a guardrails desired state
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   account: set this if desired state is associated with multiple 
#   accounts, and we only want to run against a specific account
#   id: Identifier for guardrails desired state to be run
#   mode: Override desired state mode if required
runDesiredState(
account: GuardrailsAccountSelector,
id: ID!,
mode: GuardrailsDesiredStateMode
): GuardrailsDesiredStateRunResponse 
#   Test a desired state. This API is intended for validation or confirming the 
#   output of a desired state run.
#   We can use this to test a desired state which can either be in ENFORCEMENT or 
#   MONITOR mode.
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   account: set this if desired state is associated with multiple 
#   accounts, and we only want to test against a specific account
#   id: Identifier for guardrails desired state to be run
testDesiredState(account: GuardrailsAccountSelector, id: ID!): GuardrailsDesiredStateRunResponse 
#   Create or Update a guardrails desired state
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   contentSource: Guardrails content source
#   desiredState: guardrails desired state input - name, 
#   description, parameters etc.
upsertDesiredState(
contentSource: GuardrailsContentSource,
desiredState: GuardrailsDesiredStateInput!
): GuardrailsDesiredState 
#   Create or Update a guardrails template
# 
#   **NOTE:** This API/functionality is in Alpha, This functionality can be unstable 
#   and schema elements may change over future iterations.
# 
# Arguments
#   content: Content of guardrails template along with other 
#   content information like content type etc.
#   meta: Guardrails template input - name, description, category 
#   etc.
upsertTemplate(
content: GuardrailsTemplateContent,
meta: GuardrailsTemplateInput
): GuardrailsTemplate 
#   Add Guardrails worker group cloud accounts. This applies to type = REMEDIATION
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   cloudAccounts: Cloud accounts
#   groupId: Id of the guardrails worker group
addWorkerGroupCloudAccounts(
cloudAccounts: [GuardrailsWorkerGroupAccountInput!],
groupId: ID!
): GuardrailsWorkerGroup! 
#   Registers a worker and creates required access keys
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   workerInfo: [Not documented]
bootstrapWorker(workerInfo: GuardrailsWorkerBootstrapInput!): GuardrailsWorkerBootstrapResult 
#   Delete Guardrails worker groups
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   ids: Ids of the guardrails worker groups to be deleted. Delete 
#   multi worker groups are not supported.
deleteWorkerGroup(ids: [ID!]): [GuardrailsWorkerGroupDeleteResult!] 
#   Delete Guardrails worker group cloud accounts
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   cloudAccountIds: Ids of the guardrails worker group 
#   cloudAccount. Delete multi cloud accounts are not supported
#   groupId: Id of the guardrails worker group
deleteWorkerGroupCloudAccounts(
cloudAccountIds: [ID!]!,
groupId: ID!
): GuardrailsWorkerGroup! 
#   Delete Guardrails workers"
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   groupId: Id of the guardrails worker group
#   workerIds: Ids of the guardrails worker group workers. Delete 
#   multi workers are not supported
deleteWorkers(groupId: ID!, workerIds: [ID!]!): [GuardrailsWorkerDeleteResult!]! 
#   Generate guardrails worker group secret
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   workerGroupId: [Not documented]
generateWorkerGroupSecret(workerGroupId: ID): GuardrailsWorkerGroupSecret 
#   Update Guardrails worker group cloud accounts. This applies to type = 
#   REMEDIATION
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   cloudAccount: Cloud account.
#   groupId: Id of the guardrails worker group
#   id: Id of the cloud account.
updateWorkerGroupCloudAccounts(
cloudAccount: GuardrailsWorkerGroupAccountInput!,
groupId: ID!,
id: ID!
): GuardrailsWorkerGroup! 
#   Create or Update a guardrails worker group
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   guardrailsWorkerGroup: [Not documented]
upsertWorkerGroup(
guardrailsWorkerGroup: GuardrailsWorkerGroupInput!
): GuardrailsWorkerGroup 
#   Delete Guardrails remediation action.
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   ids: Ids of the guardrails remediation action to be deleted.
deleteRemediationAction(ids: [ID!]): [GuardrailsRemediationActionDeleteResult!] 
#   Remediate finding.
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   actionId: Action Identifier
#   findingId: List of finding identifiers.
remediateFinding(actionId: String!, findingId: [String!]!): GuardrailsRemediateFindingResult! 
#   Create a Guardrail's remediation action.
#   Action is a definition of which remediation Job is run when certain criteria are 
#   met.
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   action: [Not documented]
upsertRemediationAction(
action: GuardrailsRemediationActionInput!
): GuardrailsRemediationAction 
}
Require by

Mutationnull
GuardrailsMutations

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
