Get agent details

Retrieves details for a specific agent

GET /v1/agents/{agentId}

Get agent details

cURL

curl --request GET \
  --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.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', 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 => "GET",
  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("GET", 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.get("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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agentStatus": "running",
  "agentType": "data_productivity_cloud",
  "cloudProvider": "aws",
  "connected": true,
  "deployment": "fargate",
  "description": "An AWS Agent",
  "enableAutoUpdates": true,
  "name": "AWS Agent",
  "pausedUntil": "2025-01-01T00:00:00.000Z",
  "restrictedAccess": true,
  "versionDetails": {
    "agentUpdateAvailable": false,
    "agentVersion": "1.0.0",
    "support": "SUPPORTED",
    "trackName": "current",
    "trackReleaseDate": "2025-01-01T00:00:00.000Z",
    "trackVersion": "1.0.0"
  }
}

{
  "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 retrieve

Response

200

application/json

Success

agentId · string

The ID of the Agent

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

agentStatus · string

The reported status of the Agent

Example:

"running"

agentType · string

The type of Agent

Example:

"data_productivity_cloud"

cloudProvider · string

The cloud provider the Agent is hosted in

Example:

"aws"

connected · boolean

Whether the Agent is connected

Example:

true

deployment · string

The deployment type of the Agent

Example:

"fargate"

description · string

The description set for the Agent

Example:

"An AWS Agent"

enableAutoUpdates · boolean

Whether the Agent is set to automatically update

Example:

true

name · string

The name of the Agent

Example:

"AWS Agent"

pausedUntil · string

The date and time the Agent will be unpaused automatically. Only returned if the Agent is currently paused

Example:

"2025-01-01T00:00:00.000Z"

restrictedAccess · boolean

Whether the Agent is restricted to a specific set of projects

Example:

true

versionDetails · object

The version details of the Agent

Show child attributes