Get the Agent Allow list

Get the list of projects the Agent is restricted to only when the agent has the property restrictedAccess set to true.

If restrictedAccess is set to true and the list of projects is empty, then the Agent will not be applicable to be assigned to any project.

If restrictedAccess is set to false for the Agent, then restriction to these projects will not be enforced.

GET /v1/agents/{agentId}/allowlist

Get the Agent Allow list

cURL

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

import requests

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

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}/allowlist', 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}/allowlist",
  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}/allowlist"

	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}/allowlist")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "projects": {
    "projects": {
      "3fa85f64-5717-4562-b3fc-2c963f66afa6": {
        "environments": [
          "dev",
          "prod"
        ]
      },
      "1398aa31-af57-4a6a-9752-27c2e8556c3f": {
        "environments": [
          "prod"
        ]
      }
    }
  }
}

{
  "type": "https://api.matillion.com/problems/bad-request",
  "title": "Bad request",
  "status": 400,
  "detail": "Invalid request format. Please check the parameters supplied.",
  "instance": "/v1/agents/{agentId}/allowlist"
}

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

{
  "type": "https://api.matillion.com/problems/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "None found",
  "instance": "/v1/agents/{agentId}/allowlist"
}

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

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

agentId · string · required

The ID of the agent having the allow list set

Response

200

application/json

Agent allow list successfully retrieved

projects · object · required

The list of projects the Agent is scoped to. Each project will be displayed as an object with the Project ID as the key.

Show child attributes

Example:

{
  "projects": {
    "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "environments": ["dev", "prod"] },
    "1398aa31-af57-4a6a-9752-27c2e8556c3f": { "environments": ["prod"] }
  }
}