Foundry Lookup Files

Operations for the Foundry Lookup Files service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust	v0.7.1
Ruby	v1.4.0

---

Table of Contents

Operation	Description
CreateFileV1 create_file_v1	Creates a lookup file within a foundry app
UpdateFileV1 update_file_v1	Updates a lookup file within a Foundry app

---

CreateFileV1

Creates a lookup file within a foundry app

Method POST

Route /loggingapi/entities/lookup-files/v1

PEP 8 create_file_v1

Parameters

file body · file

File to be uploaded

name body · string

Name used to identify the file

description body · string

File description

id body · string

Unique identifier of the file being updated.

repo body · string

Name of repository or view to save the file

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import FoundryLookupFiles

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

response = falcon.create_file_v1(file_name="string",
                                 file="string",
                                 name="string",
                                 description="string",
                                 id="string",
                                 repo="string")
print(response)

Operation ID

from falconpy import FoundryLookupFiles

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

response = falcon.CreateFileV1(file_name="string",
                               file="string",
                               name="string",
                               description="string",
                               id="string",
                               repo="string")
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("CreateFileV1",
                          file_data=open("filename", "rb").read(),
                          name="string",
                          description="string",
                          id="string",
                          repo="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/foundry_lookup_files"
)

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)
  }

  description := "string"
  iD := "string"
  repo := "string"

  response, err := client.FoundryLookupFiles.CreateFileV1(
    &foundry_lookup_files.CreateFileV1Params{
      Name: "string",
      Description: &description,
      ID: &iD,
      Repo: &repo,
      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: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.foundryLookupFiles.createFileV1(
  "string",  // file
  "string",  // name
  "string",  // xCSUSERNAME
  "string",  // description
  "string",  // id
  "string"  // repo
);

console.log(response);

Rust

use rusty_falcon::apis::lookup_files_api::create_file_v1;
use rusty_falcon::easy::client::FalconHandle;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let response = create_file_v1(
        &falcon.cfg,  // configuration
        std::path::PathBuf::default(),  // file
        "string",  // name
        Some("string"),  // x_cs_username
        Some("string"),  // x_cs_useruuid
        Some("string"),  // description
        Some("string"),  // id
        Some("string"),  // repo
    ).await.expect("API call failed");

    println!("{:?}", response);
}

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::FoundryLookupFiles.new

response = api.create_file_v1('string', 'string')

puts response

Responses

200 OK

[
  {
    "app_id": "string",
    "cid": "string",
    "contents_hash": "string",
    "created_by": {},
    "created_timestamp": "string",
    "description": "string",
    "filename": "string",
    "format": "string",
    "id": "string",
    "last_modified_by": {},
    "last_modified_timestamp": "string",
    "name": "string",
    "repo": "string",
    "size": 0,
    "status": "string",
    "version": "string",
    "version_numeric": 0
  }
]

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
    }
  }
}

---

---

UpdateFileV1

Updates a lookup file within a Foundry app

Method PATCH

Route /loggingapi/entities/lookup-files/v1

PEP 8 update_file_v1

Parameters

id body · string

Unique identifier of the file being updated.

description body · string

File description

file body · file

File to be uploaded

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import FoundryLookupFiles

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

response = falcon.update_file_v1(file_name="string",
                                 id="string",
                                 description="string",
                                 file="string")
print(response)

Operation ID

from falconpy import FoundryLookupFiles

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

response = falcon.UpdateFileV1(file_name="string",
                               id="string",
                               description="string",
                               file="string")
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("UpdateFileV1",
                          id="string",
                          description="string",
                          file_data=open("filename", "rb").read())
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

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)
  }

  description := "string"

  response, err := client.FoundryLookupFiles.UpdateFileV1(
    &foundry_lookup_files.UpdateFileV1Params{
      ID: "string",
      Description: &description,
      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: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.foundryLookupFiles.updateFileV1(
  "string",  // id
  "string",  // xCSUSERNAME
  "string",  // description
  "string"  // file
);

console.log(response);

Rust

use rusty_falcon::apis::lookup_files_api::update_file_v1;
use rusty_falcon::easy::client::FalconHandle;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let response = update_file_v1(
        &falcon.cfg,  // configuration
        "string",  // id
        Some("string"),  // x_cs_username
        Some("string"),  // x_cs_useruuid
        Some("string"),  // description
        Some(std::path::PathBuf::default()),  // file
    ).await.expect("API call failed");

    println!("{:?}", response);
}

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::FoundryLookupFiles.new

response = api.update_file_v1('string')

puts response

Responses

200 OK

[
  {
    "app_id": "string",
    "cid": "string",
    "contents_hash": "string",
    "created_by": {},
    "created_timestamp": "string",
    "description": "string",
    "filename": "string",
    "format": "string",
    "id": "string",
    "last_modified_by": {},
    "last_modified_timestamp": "string",
    "name": "string",
    "repo": "string",
    "size": 0,
    "status": "string",
    "version": "string",
    "version_numeric": 0
  }
]

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
    }
  }
}