Agents

Operations for the Agents service collection.

Language	Last Update
Python	v1.6.6
PowerShell
Go	v0.24.0
TypeScript	v0.9.0
Rust
Ruby	v1.6.0

---

Table of Contents

Operation	Description
CreateOrEditAgentExternalV3 create_or_update_agent	Create or update an agent.
DeleteAgentV1 delete_agent	Delete an agent and all of its versions.
GetAgentsV2 get_studio_agents	Retrieve agents entities for the provided ids.
PatchAgentExternalV3 update_agent	Modifies existing agents
QueryAgentsV2 query_studio_agents	Query agents based on the provided filters.

---

CreateOrEditAgentExternalV3

Create or update an agent.

Method POST

Route /agentic-studio/entities/agents/v3

Scope Charlotte AI Agent Definition: WRITE

PEP 8 create_or_update_agent

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

duplicate_from_agent_id body · string

The duplicate_from_agent_id value.

id body · string

The id value.

template_id body · string

The template_id value.

version_definition body · object

The version_definition value.

Code Examples

Python

PEP 8

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

version_definition = {
    "compaction_config": {
        "enabled": True,
        "threshold": 0.0
    },
    "description": "string",
    "input_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "knowledge_base_ids": [
        "string"
    ],
    "model": "string",
    "model_config": {
        "enable_reasoning": True,
        "frequency_penalty": 0.0,
        "max_tokens": 0,
        "reasoning_effort": "string",
        "temperature": 0.0,
        "top_k": 0,
        "top_p": 0.0
    },
    "name": "string",
    "output_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "parent_version_ids": [
        "string"
    ],
    "skill_ids": [
        "string"
    ],
    "system_prompt": "string",
    "targeting_config": {
        "agent_to_agent": True,
        "apigw": True,
        "charlotte_ai": True,
        "fusion_workflows": True
    },
    "tools": [
        {
            "description_override": "string",
            "id": "string",
            "meta": "string",
            "name": "string",
            "name_override": "string",
            "parameter_overrides": "string",
            "type": "string"
        }
    ]
}

response = falcon.create_or_update_agent(duplicate_from_agent_id="string",
                                         id="string",
                                         template_id="string",
                                         version_definition=version_definition)
print(response)

Operation ID

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

version_definition = {
    "compaction_config": {
        "enabled": True,
        "threshold": 0.0
    },
    "description": "string",
    "input_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "knowledge_base_ids": [
        "string"
    ],
    "model": "string",
    "model_config": {
        "enable_reasoning": True,
        "frequency_penalty": 0.0,
        "max_tokens": 0,
        "reasoning_effort": "string",
        "temperature": 0.0,
        "top_k": 0,
        "top_p": 0.0
    },
    "name": "string",
    "output_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "parent_version_ids": [
        "string"
    ],
    "skill_ids": [
        "string"
    ],
    "system_prompt": "string",
    "targeting_config": {
        "agent_to_agent": True,
        "apigw": True,
        "charlotte_ai": True,
        "fusion_workflows": True
    },
    "tools": [
        {
            "description_override": "string",
            "id": "string",
            "meta": "string",
            "name": "string",
            "name_override": "string",
            "parameter_overrides": "string",
            "type": "string"
        }
    ]
}

response = falcon.CreateOrEditAgentExternalV3(duplicate_from_agent_id="string",
                                              id="string",
                                              template_id="string",
                                              version_definition=version_definition)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "duplicate_from_agent_id": "string",
    "id": "string",
    "template_id": "string",
    "version_definition": {
        "compaction_config": {
            "enabled": boolean,
            "threshold": integer
        },
        "description": "string",
        "input_format": {
            "format": "string",
            "json_schema": "string",
            "usage_instructions": "string"
        },
        "knowledge_base_ids": ["string"],
        "model": "string",
        "model_config": {
            "enable_reasoning": boolean,
            "frequency_penalty": integer,
            "max_tokens": integer,
            "reasoning_effort": "string",
            "temperature": integer,
            "top_k": integer,
            "top_p": integer
        },
        "name": "string",
        "output_format": {
            "format": "string",
            "json_schema": "string",
            "usage_instructions": "string"
        },
        "parent_version_ids": ["string"],
        "skill_ids": ["string"],
        "system_prompt": "string",
        "targeting_config": {
            "agent_to_agent": boolean,
            "apigw": boolean,
            "charlotte_ai": boolean,
            "fusion_workflows": boolean
        },
        "tools": [
            {
                "description_override": "string",
                "id": "string",
                "meta": {},
                "name": "string",
                "name_override": "string",
                "parameter_overrides": {},
                "type": "string"
            }
        ]
    }
}

response = falcon.command("CreateOrEditAgentExternalV3", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/agents"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  waitForReady := boolean
  description := "string"
  model := "string"
  name := "string"
  systemPrompt := "string"

  response, createoreditagentexternalv3accepted, err := client.Agents.CreateOrEditAgentExternalV3(
    &agents.CreateOrEditAgentExternalV3Params{
      Body: &models.APICreateOrEditAgentRequest{
        DuplicateFromAgentID: "string",
        ID: "string",
        ProjectID: "string",
        TemplateID: "string",
        VersionDefinition: &models.APIAgentVersionDefinitionRequest{
          CompactionConfig: &models.APICompactionConfig{},
          Description: &description,
          InputFormat: &models.APIAgentInputFormat{},
          KnowledgeBaseIds: []string{"string"},
          Model: &model,
          ModelConfig: &models.APIAgentModelConfig{},
          Name: &name,
          OutputFormat: &models.APIAgentOutputFormat{},
          ParentVersionIds: []string{"string"},
          SkillIds: []string{"string"},
          SystemPrompt: &systemPrompt,
          TargetingConfig: &models.APIAgentTargetingConfig{},
          Tools: []*models.APIAgentTool{},
        },
      },
      WaitForReady: &waitForReady,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
  fmt.Printf("%+v\n", createoreditagentexternalv3accepted.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.agents.createOrEditAgentExternalV3(
  {  // body
      duplicateFromAgentId: "string",
      id: "string",
      projectId: "string",
      templateId: "string",
      versionDefinition: {
        compactionConfig: {
          enabled: boolean,
          threshold: integer
        },
        description: "string",
        inputFormat: {
          format: "string",
          jsonSchema: "string",
          usageInstructions: "string"
        },
        knowledgeBaseIds: [],
        model: "string",
        modelConfig: {
          enableReasoning: boolean,
          frequencyPenalty: integer,
          maxTokens: integer,
          reasoningEffort: "string",
          temperature: integer,
          topK: integer,
          topP: integer
        },
        name: "string",
        outputFormat: {
          format: "string",
          jsonSchema: "string",
          usageInstructions: "string"
        },
        parentVersionIds: [],
        skillIds: [],
        systemPrompt: "string",
        targetingConfig: {
          agentToAgent: boolean,
          apigw: boolean,
          charlotteAi: boolean,
          fusionWorkflows: boolean
        },
        tools: [{
            descriptionOverride: "string",
            id: "string",
            meta: {},
            name: "string",
            nameOverride: "string",
            parameterOverrides: {},
            type: "string"
          }]
      }
  },
  boolean  // waitForReady
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::Agents.new

body = Falcon::ApiCreateOrEditAgentRequest.new(
  duplicate_from_agent_id: 'string',
  id: 'string',
  template_id: 'string',
  version_definition: {
    compaction_config: {
      enabled: boolean,
      threshold: integer
    },
    description: 'string',
    input_format: {
      format: 'string',
      json_schema: 'string',
      usage_instructions: 'string'
    },
    knowledge_base_ids: [],
    model: 'string',
    model_config: {
      enable_reasoning: boolean,
      frequency_penalty: integer,
      max_tokens: integer,
      reasoning_effort: 'string',
      temperature: integer,
      top_k: integer,
      top_p: integer
    },
    name: 'string',
    output_format: {
      format: 'string',
      json_schema: 'string',
      usage_instructions: 'string'
    },
    parent_version_ids: [],
    skill_ids: [],
    system_prompt: 'string',
    targeting_config: {
      agent_to_agent: boolean,
      apigw: boolean,
      charlotte_ai: boolean,
      fusion_workflows: boolean
    },
    tools: [{
        description_override: 'string',
        id: 'string',
        meta: {},
        name: 'string',
        name_override: 'string',
        parameter_overrides: {},
        type: 'string'
      }]
  }
)

response = api.create_or_edit_agent_external_v3(body)

puts response

Responses

200 Successfully created/updated

[
  {
    "agent": {},
    "agent_version": {}
  }
]

202 Accepted; registration still in progress

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "agent": {},
      "agent_version": {}
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

DeleteAgentV1

Delete an agent and all of its versions.

Method DELETE

Route /agentic-studio/entities/agents/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 delete_agent

Parameters

id query · string

Agent ID

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_agent(id=id_list)
print(response)

Operation ID

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.DeleteAgentV1(id=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("DeleteAgentV1",
                          id="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/agents"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.Agents.DeleteAgentV1(
    &agents.DeleteAgentV1Params{
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.agents.deleteAgentV1(
  "string",  // id
  "string"  // projectId
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::Agents.new

response = api.delete_agent_v1('string')

puts response

Responses

200 Successfully deleted

[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

GetAgentsV2

Retrieve agents entities for the provided ids.

Method GET

Route /agentic-studio/entities/agents/v2

Scope Charlotte AI Agent Definition: READ

PEP 8 get_studio_agents

Parameters

ids query · string or list of strings

IDs of entities to retrieve.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_studio_agents(ids=id_list)
print(response)

Operation ID

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetAgentsV2(ids=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetAgentsV2",
                          ids=id_list)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/agents"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.Agents.GetAgentsV2(
    &agents.GetAgentsV2Params{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.agents.getAgentsV2(
  ["ID1", "ID2", "ID3"],  // ids
  "string"  // projectId
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::Agents.new

response = api.get_agents_v2(['ID1', 'ID2', 'ID3'])

puts response

Responses

200 Successfully retrieved

[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

PatchAgentExternalV3

Modifies existing agents

Method PATCH

Route /agentic-studio/entities/agents/v3

Scope Charlotte AI Agent Definition: WRITE

PEP 8 update_agent

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

is_enabled body · boolean

The is_enabled value.

is_published body · boolean

The is_published value.

version_id body · string

The version_id value.

id query · string

Agent ID

dry_run query · boolean

Validate publishing without publishing the agent.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.update_agent(id="string",
                               dry_run=boolean,
                               is_enabled=boolean,
                               is_published=boolean,
                               version_id="string")
print(response)

Operation ID

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.PatchAgentExternalV3(id="string",
                                       dry_run=boolean,
                                       is_enabled=boolean,
                                       is_published=boolean,
                                       version_id="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "is_enabled": boolean,
    "is_published": boolean,
    "version_id": "string"
}

response = falcon.command("PatchAgentExternalV3",
                          id="string",
                          dry_run=boolean,
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/agents"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  dryRun := boolean
  isPublished := boolean
  versionID := "string"

  response, patchagentexternalv3accepted, err := client.Agents.PatchAgentExternalV3(
    &agents.PatchAgentExternalV3Params{
      Body: &models.APIPatchAgentRequest{
        IsEnabled: boolean,
        IsPublished: &isPublished,
        VersionID: &versionID,
      },
      ID: "string",
      DryRun: &dryRun,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
  fmt.Printf("%+v\n", patchagentexternalv3accepted.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.agents.patchAgentExternalV3(
  "string",  // id
  {  // body
      isEnabled: boolean,
      isPublished: boolean,
      versionId: "string"
  },
  boolean,  // dryRun
  boolean,  // waitForReady
  "string"  // projectId
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::Agents.new

body = Falcon::ApiPatchAgentRequest.new(
  is_enabled: boolean,
  is_published: boolean,
  version_id: 'string'
)

response = api.patch_agent_external_v3('string', body)

puts response

Responses

200 Successfully modified

[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

202 The request was accepted. The agent is not ready for invocations yet.

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "agent_major_version_bump": false,
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "active_version": {},
      "attribution": {},
      "cid": "string",
      "duplicate_from_agent_id": "string",
      "id": "string",
      "is_deleted": false,
      "is_in_sync": false,
      "published_version_ids": [],
      "tags": [],
      "template_id": "string"
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

409 Version conflict — the agent was modified concurrently

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

QueryAgentsV2

Query agents based on the provided filters.

Method GET

Route /agentic-studio/queries/agents/v2

Scope Charlotte AI Agent Definition: READ

PEP 8 query_studio_agents

Parameters

offset query · integer

Starting index of overall result set from which to return ids.

limit query · integer

Number of IDs to return. Offset + limit should NOT be above 10K.

sort query · string

Possible order by fields: created_date. Ex: ‘created_date|desc’.

filter query · string

FQL query specifying the filter parameters.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.query_studio_agents(offset=integer,
                                      limit=integer,
                                      sort="string",
                                      filter="string")
print(response)

Operation ID

from falconpy import Agents

falcon = Agents(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.QueryAgentsV2(offset=integer,
                                limit=integer,
                                sort="string",
                                filter="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueryAgentsV2",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/agents"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  offset := int64(0)
  limit := int64(0)
  sort := "string"
  filter := "string"

  response, err := client.Agents.QueryAgentsV2(
    &agents.QueryAgentsV2Params{
      Offset: &offset,
      Limit: &limit,
      Sort: &sort,
      Filter: &filter,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.agents.queryAgentsV2(
  integer,  // offset
  integer,  // limit
  "string",  // sort
  "string",  // filter
  "string"  // projectId
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::Agents.new

response = api.query_agents_v2(offset: integer,
                               limit: integer,
                               sort: 'string',
                               filter: 'string')

puts response

Responses

200 Successfully retrieved

[
  "string"
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}