Skip to main content
DELETE
/
agents
/
{agentId}
cURL
curl --request DELETE \
  --url https://api.lightspark.com/grid/2025-10-13/agents/{agentId} \
  --header 'Authorization: Basic <encoded-value>'
import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

await client.agents.delete('agentId');
package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.agents.AgentDeleteParams

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    client.agents().delete("agentId")
}
{
  "status": 401,
  "message": "<string>",
  "details": {}
}
{
  "status": 404,
  "message": "<string>",
  "details": {}
}
{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

​
Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

​
agentId
string
required

System-generated unique agent identifier

Response

Agent deleted successfully