Gateways

An OPA Gateway controls access to servers in your Project.

See Okta Privileged Access gateways.

List all Gateway Setup Tokens

Lists all Gateway Setup Tokens for your Team

This endpoint requires the following role: resource_admin.

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

query Parameters
count
integer <int32>

The number of objects per page

descending
boolean

The object order

offset
string

The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.

prev
boolean

The direction of paging

Responses
200

OK

get/v1/teams/{team_name}/gateway_setup_tokens
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Create a Gateway Setup Token
Creates a Gateway Setup Token for your Team


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
Request Body schema: application/json
required
description
string or null  [ 1 .. 1024 ] characters 
The description for the Gateway Setup Token


 
required
object
An object that defines the labels applied to associated Gateways


 
object or null
 
property name*
additional property
string
 
name
string <regex>   [ 1 .. 255 ] characters ^[\w\-_.]+$
The name for the Gateway Setup Token


 
registration_type
required
any (GatewaySetupTokenRegistrationType) 
The type of registration policy


 Value: "gateway-agent"  
Responses 
201
Created


post/v1/teams/{team_name}/gateway_setup_tokens
Request samples 
application/json
{
  • "labels": {
    • "env": "dev",
    • "region": "us-west-2"
    }
}
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "Production gateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
Retrieve a Gateway Setup Token
Retrieves the specified Gateway Setup Token


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_setup_token_id
required
string
The UUID of a Gateway Setup Token


 
Responses 
200
OK


get/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}
Request samples 
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "Production gateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
Delete a Gateway Setup Token
Deletes the specified Gateway Setup Token


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_setup_token_id
required
string
The UUID of a Gateway Setup Token


 
Responses 
204
No Content


delete/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}
Request samples 
Retrieve a Gateway Setup Token
Retrieves the specified Gateway Setup Token


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_setup_token_id
required
string
The UUID of a Gateway Setup Token


 
Responses 
200
OK


get/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}/token
Request samples 
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "Production gateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
List all Gateways
Lists all Gateways for your Team


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
query Parameters
contains
string
Only return results that include the specified value


 
count
integer <int32> 
The number of objects per page


 
descending
boolean
The object order


 
offset
string
The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.


 
prev
boolean
The direction of paging


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Retrieve a Gateway
Retrieves the properties of a specified Gateway


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_id
required
string
The UUID of a Gateway


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
Response samples 
application/json
{
  • "access_address": "192.168.190.144:7234",
  • "cloud_provider": "aws",
  • "default_address": "192.168.19.32",
  • "description": "string",
  • "id": "napa5791-fc26-4386-93f4-eca6a157ew15",
  • "labels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "last_seen": "2023-08-25T13:00:00.000000Z",
  • "name": "Production gateway",
  • "refuse_connections": false
}
Update a Gateway
Updates a specified Gateway


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_id
required
string
The UUID of a Gateway


 
Request Body schema: application/json
required
access_address
string
The IP address used to access the Gateway


 
default_address
string
The default IP address used to access the gateway. This is generally supplied by the network interface or cloud provider metadata.


 
description
string or null  [ 1 .. 1024 ] characters 
The description of the Gateway


 
required
object
The labels associated with the Gateway. Used by Projects to select Gateways.


 
property name*
additional property
string
 
name
required
string <regex>   [ 1 .. 255 ] characters ^[\w\-_.]+$
The name for the Gateway


 
Responses 
204
No Content


put/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
application/json
{
  • "access_address": "192.168.190.144:7234",
  • "default_address": "192.168.19.32",
  • "description": "string",
  • "labels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "name": "Production gateway"
}
Delete a Gateway
Deletes the specified Gateway from your Team


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_id
required
string
The UUID of a Gateway


 
Responses 
204
No Content


delete/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
Retrieve a status report for a Gateway
Retrieve a status report for the specified Gateway


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
gateway_id
required
string
The UUID of a Gateway


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways/{gateway_id}/status
Request samples 
Response samples 
application/json
{
  • "active_connections": 2,
  • "gateway_id": "3b0fdbdd-1282-440d-a973-ddc409d6d743",
  • "status": "ONLINE",
  • "total_storage_bytes": 4096,
  • "updated_at": "0001-01-01T00:00:00Z",
  • "used_storage_bytes": 2048
}