Delete Agent Config (hard delete)

client.agentConfigs.delete(, ?): AgentConfigDeleteResponse { id, deleted, object }

DELETE/v5/agent_configs/{agent_config_id}

Permanently delete an agent config; this is a hard delete, not an archive, so the row is removed and cannot be restored.

Because a config is only a template, deleting it does not stop or alter any task already created from it. A user caller can only delete a config they created unless fine-grained access control grants access. The response echoes the deleted id.

ParametersExpand Collapse

agentConfigID: string

ReturnsExpand Collapse

AgentConfigDeleteResponse { id, deleted, object }

id: string

deleted: boolean

object?: "agent_config"

Delete Agent Config (hard delete)

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const agentConfig = await client.agentConfigs.delete('agent_config_id');

console.log(agentConfig.id);

{
  "id": "id",
  "deleted": true,
  "object": "agent_config"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "agent_config"
}