v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Agents

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

Path parameters

agentIdstring required

The ID of the agent having the allow list set

Response

Agent allow list successfully retrieved

projectsobject 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.

Example response

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