v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Agents

Add project(s) and/or environment(s) to the Agent Allow list

A request to add project(s) and/or environment(s)to the Agent Allow list.

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

patch/v1/agents/{agentId}/allowlist

Path parameters

agentIdstring required

The ID of the agent to add the project(s) and/or environment(s) to for access

Request body

projectsobject required

The list of projects and associated environments to be added to the list the Agent is allowed to be scoped to. Each project should be provided as an object with the Project ID. The list of projects cannot be left empty.

Example request

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

Response

Project and/or environment successfully added to the Agent Allow list