> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/sdks/overlay.md).

# Services.Overlay

## Overview

### Available Operations

* [GetKeyBasedDeduplicationOptin](#getkeybaseddeduplicationoptin) - Get Opt-in for Key Based Deduplication for a service
* [OptInForKeyBasedDeduplication](#optinforkeybaseddeduplication) - Opt-in for Key Based Deduplication for a service

## GetKeyBasedDeduplicationOptin

Get Opt-in for Key Based Deduplication for a service

### Example Usage

```go
package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Services.Overlay.GetKeyBasedDeduplicationOptin(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
```

### Parameters

| Parameter   | Type                                                                                                              | Required             | Description                         |
| ----------- | ----------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------- |
| `ctx`       | [context.Context](https://pkg.go.dev/context#Context)                                                             | :heavy\_check\_mark: | The context to use for the request. |
| `serviceID` | `string`                                                                                                          | :heavy\_check\_mark: | N/A                                 |
| `opts`      | \[][operations.Option](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/option.md) | :heavy\_minus\_sign: | The options for this request.       |

### Response

[**\*operations.OverlayGetOptinForKeyBasedDeduplicationForAServiceResponse**](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/overlaygetoptinforkeybaseddeduplicationforaserviceresponse.md)**, error**

### Errors

| Error Type                         | Status Code | Content Type     |
| ---------------------------------- | ----------- | ---------------- |
| apierrors.BadRequestError          | 400         | application/json |
| apierrors.UnauthorizedError        | 401         | application/json |
| apierrors.PaymentRequiredError     | 402         | application/json |
| apierrors.ForbiddenError           | 403         | application/json |
| apierrors.NotFoundError            | 404         | application/json |
| apierrors.ConflictError            | 409         | application/json |
| apierrors.UnprocessableEntityError | 422         | application/json |
| apierrors.InternalServerError      | 500         | application/json |
| apierrors.BadGatewayError          | 502         | application/json |
| apierrors.ServiceUnavailableError  | 503         | application/json |
| apierrors.GatewayTimeoutError      | 504         | application/json |
| apierrors.APIError                 | 4XX, 5XX    | \*/\*            |

## OptInForKeyBasedDeduplication

Opt-in for Key Based Deduplication for a service

### Example Usage

```go
package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Services.Overlay.OptInForKeyBasedDeduplication(ctx, "<id>", components.V3ServicesOverlayOptInForKeyBasedDeduplicationRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
```

### Parameters

| Parameter                                               | Type                                                                                                                                                                                                         | Required             | Description                         |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ----------------------------------- |
| `ctx`                                                   | [context.Context](https://pkg.go.dev/context#Context)                                                                                                                                                        | :heavy\_check\_mark: | The context to use for the request. |
| `serviceID`                                             | `string`                                                                                                                                                                                                     | :heavy\_check\_mark: | N/A                                 |
| `v3ServicesOverlayOptInForKeyBasedDeduplicationRequest` | [components.V3ServicesOverlayOptInForKeyBasedDeduplicationRequest](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/components/v3servicesoverlayoptinforkeybaseddeduplicationrequest.md) | :heavy\_check\_mark: | N/A                                 |
| `opts`                                                  | \[][operations.Option](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/option.md)                                                                                            | :heavy\_minus\_sign: | The options for this request.       |

### Response

[**\*operations.OverlayOptinForKeyBasedDeduplicationForAServiceResponse**](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/overlayoptinforkeybaseddeduplicationforaserviceresponse.md)**, error**

### Errors

| Error Type                         | Status Code | Content Type     |
| ---------------------------------- | ----------- | ---------------- |
| apierrors.BadRequestError          | 400         | application/json |
| apierrors.UnauthorizedError        | 401         | application/json |
| apierrors.PaymentRequiredError     | 402         | application/json |
| apierrors.ForbiddenError           | 403         | application/json |
| apierrors.NotFoundError            | 404         | application/json |
| apierrors.ConflictError            | 409         | application/json |
| apierrors.UnprocessableEntityError | 422         | application/json |
| apierrors.InternalServerError      | 500         | application/json |
| apierrors.BadGatewayError          | 502         | application/json |
| apierrors.ServiceUnavailableError  | 503         | application/json |
| apierrors.GatewayTimeoutError      | 504         | application/json |
| apierrors.APIError                 | 4XX, 5XX    | \*/\*            |
