Delete agent

deleteAgent(input: DeleteProjectAgentInput!): AgentDeletionResult!

Requires project.agents.write; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteProjectAgentInput!Yes

Input fields

input

DeleteProjectAgentInput

FieldTypeRequired
projectReferenceStringNo
agentIdString!Yes
sourceTargetKindStringNo
targetBranchIdIDNo

Response

Returns AgentDeletionResult!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: the deletion completed. A failed deletion is a GraphQL error.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteAgent($input: DeleteProjectAgentInput!) {
  deleteAgent(input: $input) {
    ok
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "agentId": "00000000-0000-4000-8000-000000000001"
  }
}