deleteApiV1AdminAgentsById

deleteApiV1AdminAgentsById<ThrowOnError>(options: Options<DeleteApiV1AdminAgentsByIdData, ThrowOnError>): RequestResult<DeleteApiV1AdminAgentsByIdResponses, DeleteApiV1AdminAgentsByIdErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:70

Delete agent

Deletes an agent by ID. Requires admin API key.

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options`	`Options`<`DeleteApiV1AdminAgentsByIdData`, `ThrowOnError`>

Returns

RequestResult<DeleteApiV1AdminAgentsByIdResponses, DeleteApiV1AdminAgentsByIdErrors, ThrowOnError>