Cloudflare.WorkerDomain (Cloudflare v0.5.0)

Worker Domain

Attach to Domain

PUT /accounts/{account_id}/workers/domains

Attaches a Worker to a zone and hostname.

Responses

200 Attach to Domain response.

Data is at body["result"]

{
  "environment": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "service": "*string*",
  "zone_id": "*string*",
  "zone_name": "*string*"
}

4XX Attach to Domain response failure.

{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

List Domains

GET /accounts/{account_id}/workers/domains

Lists all Worker Domains for an account.

Responses

200 List Domains response.

Data is at body["result"]

[
  {
    "environment": "*string*",
    "hostname": "*string*",
    "id": "*string*",
    "service": "*string*",
    "zone_id": "*string*",
    "zone_name": "*string*"
  }
]

4XX List Domains response failure.

{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get a Domain

GET /accounts/{account_id}/workers/domains/{domain_id}

Gets a Worker domain.

Responses

200 Get a Domain response.

Data is at body["result"]

{
  "environment": "*string*",
  "hostname": "*string*",
  "id": "*string*",
  "service": "*string*",
  "zone_id": "*string*",
  "zone_name": "*string*"
}

4XX Get a Domain response failure.

{
  "errors": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "documentation_url": "*string*",
      "message": "*string*",
      "source": {
        "pointer": "*string*"
      }
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Detach from Domain

DELETE /accounts/{account_id}/workers/domains/{domain_id}

Detaches a Worker from a zone and hostname.

Responses

200 Detach from Domain response.

Data is at body["result"]

4XX Detach from Domain response failure.

Summary

Functions

attach(body, opts \\ [])

Attaches a Worker to a zone and hostname (PUT).

client(opts \\ [])

delete(id, opts \\ [])

delete!(id, opts \\ [])

index(opts \\ [])

index!(opts \\ [])

path_for(id, opts \\ [])

show(id, opts \\ [])

show!(id, opts \\ [])

Functions

attach(body, opts \\ [])

Attaches a Worker to a zone and hostname (PUT).

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

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()