Trigger an Agent command

The command to be triggered.

Available commands are:

• RESTART - Restart the Agent.
• PAUSE - Set the Agent to ‘Paused’.
• RESUME - Un-sets a ‘Paused’ agent.

POST /v1/agents/{agentId}/commands

Trigger an Agent command

cURL

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "RESTART"
}
'

import requests

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

payload = { "command": "RESTART" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({command: 'RESTART'})
};

fetch('https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/commands', 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}/commands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'command' => 'RESTART'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"command\": \"RESTART\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"RESTART\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"RESTART\"\n}"

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}/commands"
}

{
  "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}/commands"
}

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

{
  "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}/commands"
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

agentId · string · required

Body

application/json

command · enum<string> · required

The command being sent

Available options: RESTART, PAUSE, RESUME

Example:

"RESTART"

Response

202

Agent command received successfully