Caido
GuidesTutorialsReferenceConcepts

@caido/sdk-backend ​

This is the reference for the backend SDK used by backend plugins. SDK is the main interface that provides access to various services and functionalities.

SDK ​

SDK ​

The SDK object available to all scripts.

Type Parameters ​

Type ParameterDefault type
APIobject
Eventsobject

Properties ​

api ​

api: APISDK<API, Events>

The SDK for the API RPC service.

console ​

console: Console

The console.

This is currently the same as the global console.

env ​

env: EnvironmentSDK

The SDK for the Environment service.

events ​

events: EventsSDK<API, Events>

The SDK for the Events service.

findings ​

findings: FindingsSDK

The SDK for the Findings service.

graphql ​

graphql: GraphQLSDK

The SDK for the GraphQL service.

hostedFile ​

hostedFile: HostedFileSDK

The SDK for the HostedFile service.

meta ​

meta: MetaSDK

The SDK for metadata information about the plugin.

net ​

net: NetSDK

The SDK for the Net service.

projects ​

projects: ProjectsSDK

The SDK for the Projects service.

replay ​

replay: ReplaySDK

The SDK for the Replay service.

requests ​

requests: RequestsSDK

The SDK for the Requests service.

runtime ​

runtime: RuntimeSDK

The SDK for the runtime information.

scope ​

scope: ScopeSDK

The SDK for the Scope service.

API Reference ​