# `Aliyun.Oss.Bucket.Referer`

Bucket operations - Referer.

# `get`

```elixir
@spec get(Aliyun.Oss.Config.t(), String.t()) ::
  {:error, Exception.t()} | {:ok, Aliyun.Oss.Client.Response.t()}
```

GetBucketReferer - gets the Referer configurations of a bucket.

## Examples

    iex> Aliyun.Oss.Bucket.Referer.get(config, "some-bucket")
    {:ok, %Aliyun.Oss.Client.Response{
      data: %{
        "RefererConfiguration" => %{
          "AllowEmptyReferer" => "true",
          "AllowTruncateQueryString" => "true",
          "RefererList" => nil,
          "TruncatePath" => "false"
        }
      },
      headers: %{
        "connection" => ["keep-alive"],
        ...
      }
    }}

# `put`

```elixir
@spec put(Aliyun.Oss.Config.t(), String.t(), String.t()) ::
  {:error, Exception.t()} | {:ok, Aliyun.Oss.Client.Response.t()}
```

PutBucketReferer - configures the Referer whitelist of a bucket.

## Examples

    iex> xml_body = """
    ...> <?xml version="1.0" encoding="UTF-8"?>
    ...> <RefererConfiguration>
    ...> <AllowEmptyReferer>true</AllowEmptyReferer >
    ...>     <RefererList>
    ...>         <Referer> http://www.aliyun.com</Referer>
    ...>         <Referer> https://www.aliyun.com</Referer>
    ...>         <Referer> http://www.*.com</Referer>
    ...>         <Referer> https://www.?.aliyuncs.com</Referer>
    ...>     </RefererList>
    ...> </RefererConfiguration>
    ...>  """
    iex> Aliyun.Oss.Bucket.Referer.put(config, "some-bucket", xml_body)
    {:ok,
    %Aliyun.Oss.Client.Response{
      data: "",
      headers: %{
        "connection" => ["keep-alive"],
        "content-length" => ["0"],
        "date" => ["Wed, 09 Jul 2025 05:35:55 GMT"],
        "server" => ["AliyunOSS"],
        "x-oss-request-id" => ["686DFFBBABB8F***********"],
        "x-oss-server-time" => ["54"]
      }
    }}

---

*Consult [api-reference.md](api-reference.md) for complete listing*