curl --request PUT \
  --url https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/allowlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": {
    "3fa85f64-5717-4562-b3fc-2c963f66afa6": {
      "environments": [
        "dev",
        "prod"
      ]
    },
    "1398aa31-af57-4a6a-9752-27c2e8556c3f": {}
  }
}
'

{
  "type": "https://api.matillion.com/problems/bad-request",
  "title": "Bad request",
  "status": 400,
  "detail": "Invalid request format. Please check your request body.",
  "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"
}

Runners

Set Runner Allow List

Set the list of projects the Runner will be restricted to only when the runner has the property restrictedAccess set to true. If projects are empty, this will remove all projects the runner is restricted to, effectively making the runner inaccessible to any project when the runner property has restrictedAccess set to true.

Please keep in mind that by using endpoint you are setting the allow list and so this will overwrite any previously set values, if you want to simply update the existing allow list please refer to the PATCH endpoint.

NOTE: Whilst the Runner property restrictedAccess is set to false, any amendments will not be enforced until restrictedAccess is set to true.

PUT

agents

{agentId}

allowlist

curl --request PUT \
  --url https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/allowlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": {
    "3fa85f64-5717-4562-b3fc-2c963f66afa6": {
      "environments": [
        "dev",
        "prod"
      ]
    },
    "1398aa31-af57-4a6a-9752-27c2e8556c3f": {}
  }
}
'

{
  "type": "https://api.matillion.com/problems/bad-request",
  "title": "Bad request",
  "status": 400,
  "detail": "Invalid request format. Please check your request body.",
  "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 runner having the allow list set

Body

application/json

projects

object

required

The list of projects the Runner is allowed to be scoped to. Each project should be provided as an object with the Project ID, or the list can be left empty.

Show child attributes

Example:

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

Response

Runner allow list successfully updated