Cloudflare.ZeroTrustHostnameRoute (Cloudflare v0.5.0)

Copy Markdown View Source

Zero Trust Hostname Route

Create hostname route

POST /accounts/{account_id}/zerotrust/routes/hostname

Create a hostname route.

Responses

200 Create hostname route response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "tunnel_id": "*string*",
  "tunnel_name": "*string*"
}
4XX Create hostname route response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List hostname routes

GET /accounts/{account_id}/zerotrust/routes/hostname

Lists and filters hostname routes in an account.

Responses

200 List hostname routes response

Data is at body["result"]

[
  {
    "comment": "*string*",
    "created_at": "*string*",
    "deleted_at": "*string*",
    "hostname": "*string*",
    "id": "*string*",
    "tunnel_id": "*string*",
    "tunnel_name": "*string*"
  }
]
4XX List hostname routes failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Update hostname route

PATCH /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Updates a hostname route.

Responses

200 Update hostname route response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "tunnel_id": "*string*",
  "tunnel_name": "*string*"
}
4XX Update hostname route response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get hostname route

GET /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Get a hostname route.

Responses

200 Get hostname route response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "tunnel_id": "*string*",
  "tunnel_name": "*string*"
}
4XX Get hostname route response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete hostname route

DELETE /accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Delete a hostname route.

Responses

200 Delete hostname route response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "tunnel_id": "*string*",
  "tunnel_name": "*string*"
}
4XX Delete hostname route response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

client(opts \\ [])

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

update(id, body, opts \\ [])

@spec update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: {:ok, map()} | {:error, term()}

update!(id, body, opts \\ [])

@spec update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: map() | no_return()