Hosted gateway

Turn enforcement on or off for one of the workspace's gateways

POST
/v1/public/account/workspace/deployments/mode

Signed account session, current workspace ADMIN or OWNER and verified email; same-site JSON is mandatory. Acts on the gateway deployment_id names, else the primary; every gateway has its own mode, upstream credential and named policy. The upstream credential is sealed at once and never logged, echoed or returned. An explicit id the workspace does not hold is 404 GATEWAY_NOT_FOUND.

Authorization

AccountSessionCookie
decionis_account_session<token>

The signed HttpOnly account session the web app holds after sign-in (also accepted as a Bearer acct_ token).

In: cookie

Query Parameters

deployment_id?string

One of the current workspace's gateways; omitted, the workspace's primary. The organization always comes from the session, never from a parameter.

Formatuuid

Request Body

application/json

mode*string

Value in

  • "SHADOW"
  • "ENFORCEMENT"
accept_terms*boolean
upstream_credential?

Enforcement only; sealed at once, never returned.

policy_id?|

The named policy the gateway is decided by; null is the workspace default, omitted keeps it.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/public/account/workspace/deployments/mode" \  -H "Content-Type: application/json" \  -d '{    "mode": "SHADOW",    "accept_terms": true  }'
{  "deployment": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "tenant_label": "string",    "tenant_host": "string",    "gateway_url": "string",    "status": "reserved",    "upstream_origin": "string",    "runtime_verified": true  },  "deployments": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "tenant_host": "acme.decionisedge.com",      "is_primary": true,      "status": "queued",      "running_mode": "SHADOW"    }  ],  "deployment_limit": 1,  "credentials": [    {}  ],  "gateway_token": {    "header": "AgentSafe-Gateway-Token",    "issued": true,    "revealable": true,    "sent": true,    "sent_at": "2019-08-24T14:15:22Z",    "pending_at": "2019-08-24T14:15:22Z"  },  "enforcement": {},  "networking": {},  "activation": {}}