Command reference
deployments grant
Agent connection grants
| Command | Summary |
|---|---|
deployments grant create | Grant a connection to an agent |
deployments grant list | List connection grants |
deployments grant show | Show a connection grant |
deployments grant revoke | Revoke a connection grant |
deployments grant create
Grant a connection to an agent.
deployments grant create --connection <connection> --purpose <purpose> --scopes <a-b-c>- Calls
POST /v1/connection-grants(SDKcreateConnectionGrant). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--workspace | string | Workspace ID | ||
--all-workspaces | boolean | Grant the connection to every workspace in the environment | ||
--connection | string | yes | Provider connection ID | |
--constraints | string (json) | External resource constraints | ||
--purpose | string | yes | Authorization purpose | |
--scopes | string (a,b,c) | yes | Granted connection scopes |
Also accepts the global flags.
deployments grant list
List connection grants.
deployments grant list- Calls
GET /v1/connection-grants(SDKlistConnectionGrants). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments grant show
Show a connection grant.
deployments grant show <id>- Calls
GET /v1/connection-grants/{id}(SDKgetConnectionGrant). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments grant revoke
Revoke a connection grant.
deployments grant revoke <id>- Calls
DELETE /v1/connection-grants/{id}(SDKrevokeConnectionGrant). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--reason | string | Reason for this operation |
Also accepts the global flags.