Delete an Agent

This request can only be used to delete agents that have a STOPPED, PENDING or UNKNOWN status. In the case of an agent at UNKNOWN status, there is a delay of up to one hour after its preceding status before the agent can be deleted successfully.

DELETE /v1/agents/{agentId}

Delete an Agent

cURL

curl --request DELETE \
  --url https://eu1.api.matillion.com/dpc/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/agents/{agentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu1.api.matillion.com/dpc/v1/agents/{agentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/agents/{agentId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://eu1.api.matillion.com/dpc/v1/agents/{agentId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/agents/{agentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

400

{
  "type": "https://api.matillion.com/problems/bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Failed to read request. Please check your request body.",
  "instance": "/v1/agents/{agentId}"
}

{
  "type": "https://api.matillion.com/problems/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have permission to access this resource.",
  "instance": "/v1/agents/{agentId}"
}

{
  "type": "https://api.matillion.com/problems/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested agent does not exist.",
  "instance": "/v1/agents/{agentId}"
}

{
  "type": "https://api.matillion.com/problems/internal-server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Unexpected error occurred while processing the request.",
  "instance": "/v1/agents/{agentId}"
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

agentId · string · required

The ID of the agent to delete

Response

202

Agent successfully deleted