Remove

POST

/api/agents/{agent_alias}/remove

curl --request POST \
  --url https://example.com/api/agents/example/remove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "environment": "example" }'

Remove agent from target environment. Alias format: -.

Authorizations

• HTTPBearer

Parameters

Path Parameters

agent_alias

required

Agent Alias

string

Request Body^required

Media typeapplication/json

LifecycleRequest

object

environment

required

Environment

Target environment, such as dev, test, or prod

string

Example^generated

{
  "environment": "example"
}

Responses

200

Successful Response

Media typeapplication/json

Example^generated

example

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}