ReverseProxy endpoints

This document contains the endpoints for the ReverseProxy category.

Gets reverse proxy configuration

/api/v1/reverse-proxy Authorized

This endpoint returns the reverse proxy configuration

Gets all the reverse proxy hosts

/api/v1/reverse-proxy/hosts Authorized

This endpoint returns all the reverse proxy hosts

Gets all the reverse proxy host

/api/v1/reverse-proxy/hosts/{id} Authorized

This endpoint returns a reverse proxy host

Parameters
Name Type In Required Description
id string path required Reverse Proxy Host ID

Creates a reverse proxy host

/api/v1/reverse-proxy/hosts Authorized

This endpoint creates a reverse proxy host

Parameters
Name Type In Required Description
reverse_proxy_create_request object body optional Reverse Host Request
Schema
{
  "cors": "*ReverseProxyHostCors",
  "host": "string",
  "http_routes": "[]*ReverseProxyHostHttpRoute",
  "port": "string",
  "tcp_route": "*ReverseProxyHostTcpRoute",
  "tls": "*ReverseProxyHostTls"
}

Updates a reverse proxy host

/api/v1/reverse-proxy/hosts/{id} Authorized

This endpoint creates a reverse proxy host

Parameters
Name Type In Required Description
reverse_proxy_update_request object body optional Reverse Host Request
Schema
{
  "cors": "*ReverseProxyHostCors",
  "host": "string",
  "port": "string",
  "tls": "*ReverseProxyHostTls"
}

Delete a a reverse proxy host

/api/v1/reverse-proxy/hosts/{id} Authorized

This endpoint Deletes a reverse proxy host

Parameters
Name Type In Required Description
id string path required Reverse Proxy Host ID

Creates or updates a reverse proxy host HTTP route

/api/v1/reverse-proxy/hosts/{id}/http_route Authorized

This endpoint creates or updates a reverse proxy host HTTP route

Parameters
Name Type In Required Description
reverse_proxy_http_route_request object body optional Reverse Host Request
Schema
{
  "path": "string",
  "pattern": "string",
  "request_headers": "map[string]string",
  "response_headers": "map[string]string",
  "schema": "string",
  "target_host": "string",
  "target_port": "string",
  "target_vm_id": "string"
}

Delete a a reverse proxy host HTTP route

/api/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id} Authorized

This endpoint Deletes a reverse proxy host HTTP route

Parameters
Name Type In Required Description
id string path required Reverse Proxy Host ID
http_route_id string path required Reverse Proxy Host HTTP Route ID

Updates a reverse proxy host TCP route

/api/v1/reverse-proxy/hosts/{id}/http_routes Authorized

This endpoint updates a reverse proxy host TCP route

Parameters
Name Type In Required Description
reverse_proxy_tcp_route_request object body optional Reverse Host Request
Schema
{
  "target_host": "string",
  "target_port": "string",
  "target_vm_id": "string"
}

Restarts the reverse proxy

/api/v1/reverse-proxy/restart Authorized

This endpoint will restart the reverse proxy

Enable the reverse proxy

/api/v1/reverse-proxy/enable Authorized

This endpoint will enable the reverse proxy

Disable the reverse proxy

/api/v1/reverse-proxy/disable Authorized

This endpoint will disable the reverse proxy