Services/VPN

Endpoints related to managing an environment's VPN service.

Get VPN Service

Requires the environments-vpn capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The environmentId where the VPN resides.

Responses

200

Returns the VPN service.

default

General error response from the platform

get/v1/environments/{environmentId}/services/vpn

Response samples

200
default

application/json

{"data": {"url": "string",
"service": {"enable": true,
"container_id": "string",
"auto_update": true,
"config": {"allow_internet": true,
"auth": {"webhook": "string",
"cycle_accounts": true,
"vpn_accounts": true
}
}
}
}
}

Get VPN Logins

Requires the environments-vpn capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The environmentId where the VPN resides.

query Parameters

sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a VPNInfo resource.

default

General error response from the platform

get/v1/environments/{environmentId}/services/vpn/logins

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"username": "string",
"environment_id": "string",
"ip": "string",
"time": "2021-01-30T08:30:00Z",
"success": true
}
]
}

List VPN Users

Requires the environments-vpn-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The environmentId where the VPN service resides.

Responses

200

Returns a list of VPN users for the given VPN.

default

General error response from the platform

get/v1/environments/{environmentId}/services/vpn/users

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"username": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"last_login": "2021-01-30T08:30:00Z",
"hub_id": "651586fca6078e98982dbd90",
"environment_id": "string",
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
]
}

Create VPN User

Requires the environments-vpn-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The environmentId where the VPN service resides.

Request Body schema: application/json

Parameters for creating a new VPN user.

username required	string
password required	string

Responses

201

Returns a VPN User.

default

General error response from the platform

post/v1/environments/{environmentId}/services/vpn/users

Request samples

Payload

application/json

{"username": "string",
"password": "string"
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"username": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"last_login": "2021-01-30T08:30:00Z",
"hub_id": "651586fca6078e98982dbd90",
"environment_id": "string",
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}

Delete VPN User

Requires the environments-vpn-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId required	string The environmentId where the VPN service the given user belongs to resides.
userId required	string The userId of the user to be deleted.

Responses

200

Returns no data.

default

General error response from the platform

delete/v1/environments/{environmentId}/services/vpn/users/{userId}

Response samples

200
default

application/json

{"data": "string"
}

Create VPN Service Job

Used to reconfigure or reset the Environment VPN. Requires the environments-vpn-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The ID of the Environment the VPN service resides in.

Request Body schema: application/json

The task contents used to build the Environment VPN Job.

action

required

string

The name of the action to perform.

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/environments/{environmentId}/services/vpn/tasks

Request samples

Payload

application/json

{"action": "reset"
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

➔ Next to Hubs