# Get agent network

Read the workspace's policy for external network access, its allowed domains and whether the caller can change it.

POST https://api.brigg.app/v1/operations/workspace.GetAgentNetwork

## Access & visibility

Allow `workspace.GetAgentNetwork` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request

No parameters. Send an empty JSON object (`{}`).

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `policy` | string | Yes | Workspace policy governing external network access. |
| `allowed_domains` | array of string | Yes | Custom domains. |
| `updated_at` | number or null | Yes | Set at. |
| `workspace_domain` | string or null | Yes | Org domain. |
| `service_domains` | array of string | Yes | Brigg domains. |
| `can_manage` | boolean | Yes | Whether the acting member can change this configuration. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/workspace.GetAgentNetwork' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/workspace.GetAgentNetwork", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.GetAgentNetwork",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "policy": "unrestricted",
  "allowed_domains": [],
  "updated_at": null,
  "workspace_domain": "example.com",
  "service_domains": [],
  "can_manage": false
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "policy": {
      "type": "string",
      "description": "Workspace policy governing external network access."
    },
    "allowed_domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Custom domains."
    },
    "updated_at": {
      "type": [
        "number",
        "null"
      ],
      "description": "Set at."
    },
    "workspace_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "Org domain."
    },
    "service_domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Brigg domains."
    },
    "can_manage": {
      "type": "boolean",
      "description": "Whether the acting member can change this configuration."
    }
  },
  "required": [
    "policy",
    "allowed_domains",
    "updated_at",
    "workspace_domain",
    "service_domains",
    "can_manage"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "policy": "unrestricted",
      "allowed_domains": [],
      "updated_at": null,
      "workspace_domain": "example.com",
      "service_domains": [],
      "can_manage": false
    }
  ]
}
```