Endpoints
Create Endpoint
Create an endpoint, currently available only for cloud endpoints
Request
POST /endpoints
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
url | string | the url of the endpoint |
type | string | whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint) |
traffic_policy | string | The traffic policy attached to this endpoint |
description | string | user-supplied description of the associated tunnel |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
bindings | List<string> | the bindings associated with this endpoint |
pooling_enabled | boolean |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique endpoint resource identifier |
region | string | identifier of the region this endpoint belongs to |
created_at | string | timestamp when the endpoint was created in RFC 3339 format |
updated_at | string | timestamp when the endpoint was updated in RFC 3339 format |
public_url | string | URL of the hostport served by this endpoint |
proto | string | protocol served by this endpoint. one of http, https, tcp, or tls |
scheme | string | |
hostport | string | hostport served by this endpoint (hostname:port) -> soon to be deprecated |
host | string | |
port | int64 | |
type | string | whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint) |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
description | string | user-supplied description of the associated tunnel |
domain | Ref | the domain reserved for this endpoint |
tcp_addr | Ref | the address reserved for this endpoint |
tunnel | Ref | the tunnel serving requests to this endpoint, if this is an ephemeral endpoint |
edge | Ref | the edge serving requests to this endpoint, if this is an edge endpoint |
upstream_url | string | the local address the tunnel forwards to |
upstream_protocol | string | the protocol the agent uses to forward with |
url | string | the url of the endpoint |
principal | Ref | The ID of the owner (bot or user) that owns this endpoint |
traffic_policy | string | The traffic policy attached to this endpoint |
bindings | List<string> | the bindings associated with this endpoint |
tunnel_session | Ref | The tunnel session of the agent for this endpoint |
uri | string | URI of the clep API resource |
name | string | user supplied name for the endpoint |
pooling_enabled | boolean | whether the endpoint allows pooling |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
List Endpoints
List all active endpoints on the account
Request
GET /endpoints
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
endpoints | Endpoint | the list of all active endpoints on this account |
uri | string | URI of the endpoints list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
Endpoint fields
| Name | Type | Description |
|---|---|---|
id | string | unique endpoint resource identifier |
region | string | identifier of the region this endpoint belongs to |
created_at | string | timestamp when the endpoint was created in RFC 3339 format |
updated_at | string | timestamp when the endpoint was updated in RFC 3339 format |
public_url | string | URL of the hostport served by this endpoint |
proto | string | protocol served by this endpoint. one of http, https, tcp, or tls |
scheme | string | |
hostport | string | hostport served by this endpoint (hostname:port) -> soon to be deprecated |
host | string | |
port | int64 | |
type | string | whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint) |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
description | string | user-supplied description of the associated tunnel |
domain | Ref | the domain reserved for this endpoint |
tcp_addr | Ref | the address reserved for this endpoint |
tunnel | Ref | the tunnel serving requests to this endpoint, if this is an ephemeral endpoint |
edge | Ref | the edge serving requests to this endpoint, if this is an edge endpoint |
upstream_url | string | the local address the tunnel forwards to |
upstream_protocol | string | the protocol the agent uses to forward with |
url | string | the url of the endpoint |
principal | Ref | The ID of the owner (bot or user) that owns this endpoint |
traffic_policy | string | The traffic policy attached to this endpoint |
bindings | List<string> | the bindings associated with this endpoint |
tunnel_session | Ref | The tunnel session of the agent for this endpoint |
uri | string | URI of the clep API resource |
name | string | user supplied name for the endpoint |
pooling_enabled | boolean | whether the endpoint allows pooling |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Get Endpoint
Get the status of an endpoint by ID
Request
GET /endpoints/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique endpoint resource identifier |
region | string | identifier of the region this endpoint belongs to |
created_at | string | timestamp when the endpoint was created in RFC 3339 format |
updated_at | string | timestamp when the endpoint was updated in RFC 3339 format |
public_url | string | URL of the hostport served by this endpoint |
proto | string | protocol served by this endpoint. one of http, https, tcp, or tls |
scheme | string | |
hostport | string | hostport served by this endpoint (hostname:port) -> soon to be deprecated |
host | string | |
port | int64 | |
type | string | whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint) |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
description | string | user-supplied description of the associated tunnel |
domain | Ref | the domain reserved for this endpoint |
tcp_addr | Ref | the address reserved for this endpoint |
tunnel | Ref | the tunnel serving requests to this endpoint, if this is an ephemeral endpoint |
edge | Ref | the edge serving requests to this endpoint, if this is an edge endpoint |
upstream_url | string | the local address the tunnel forwards to |
upstream_protocol | string | the protocol the agent uses to forward with |
url | string | the url of the endpoint |
principal | Ref | The ID of the owner (bot or user) that owns this endpoint |
traffic_policy | string | The traffic policy attached to this endpoint |
bindings | List<string> | the bindings associated with this endpoint |
tunnel_session | Ref | The tunnel session of the agent for this endpoint |
uri | string | URI of the clep API resource |
name | string | user supplied name for the endpoint |
pooling_enabled | boolean | whether the endpoint allows pooling |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Update Endpoint
Update an Endpoint by ID, currently available only for cloud endpoints
Request
PATCH /endpoints/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | unique endpoint resource identifier |
url | string | the url of the endpoint |
traffic_policy | string | The traffic policy attached to this endpoint |
description | string | user-supplied description of the associated tunnel |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
bindings | List<string> | the bindings associated with this endpoint |
pooling_enabled | boolean |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique endpoint resource identifier |
region | string | identifier of the region this endpoint belongs to |
created_at | string | timestamp when the endpoint was created in RFC 3339 format |
updated_at | string | timestamp when the endpoint was updated in RFC 3339 format |
public_url | string | URL of the hostport served by this endpoint |
proto | string | protocol served by this endpoint. one of http, https, tcp, or tls |
scheme | string | |
hostport | string | hostport served by this endpoint (hostname:port) -> soon to be deprecated |
host | string | |
port | int64 | |
type | string | whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint) |
metadata | string | user-supplied metadata of the associated tunnel or edge object |
description | string | user-supplied description of the associated tunnel |
domain | Ref | the domain reserved for this endpoint |
tcp_addr | Ref | the address reserved for this endpoint |
tunnel | Ref | the tunnel serving requests to this endpoint, if this is an ephemeral endpoint |
edge | Ref | the edge serving requests to this endpoint, if this is an edge endpoint |
upstream_url | string | the local address the tunnel forwards to |
upstream_protocol | string | the protocol the agent uses to forward with |
url | string | the url of the endpoint |
principal | Ref | The ID of the owner (bot or user) that owns this endpoint |
traffic_policy | string | The traffic policy attached to this endpoint |
bindings | List<string> | the bindings associated with this endpoint |
tunnel_session | Ref | The tunnel session of the agent for this endpoint |
uri | string | URI of the clep API resource |
name | string | user supplied name for the endpoint |
pooling_enabled | boolean | whether the endpoint allows pooling |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Delete Endpoint
Delete an Endpoint by ID, currently available only for cloud endpoints
Request
DELETE /endpoints/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success