# cdn This API manages CDN distributions. ## Overview The IONOS Cloud SDK for GO provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in GO . The SDK for GO wraps the IONOS Cloud API. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response. ## Installing ### Use go get to retrieve the SDK to add it to your GOPATH workspace, or project's Go module dependencies. ```bash go get github.com/ionos-cloud/sdk-go-bundle/products/cdn.git ``` To update the SDK use go get -u to retrieve the latest version of the SDK. ```bash go get -u github.com/ionos-cloud/sdk-go-bundle/products/cdn.git ``` ### Go Modules If you are using Go modules, your go get will default to the latest tagged release version of the SDK. To get a specific release version of the SDK use @ in your go get command. To get the latest SDK repository, use @latest. ```bash go get github.com/ionos-cloud/sdk-go-bundle/products/cdn@latest ``` ## Environment Variables | Environment Variable | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `IONOS_USERNAME` | Specify the username used to login, to authenticate against the IONOS Cloud API | | `IONOS_PASSWORD` | Specify the password used to login, to authenticate against the IONOS Cloud API | | `IONOS_TOKEN` | Specify the token used to login, if a token is being used instead of username and password | | `IONOS_API_URL` | Specify the API URL. It will overwrite the API endpoint default value `api.ionos.com`. Note: the host URL does not contain the `/cloudapi/v6` path, so it should *not* be included in the `IONOS_API_URL` environment variable | | `IONOS_LOG_LEVEL` | Specify the Log Level used to log messages. Possible values: Off, Debug, Trace | | `IONOS_PINNED_CERT` | Specify the SHA-256 public fingerprint here, enables certificate pinning | ⚠️ ***Note: To overwrite the api endpoint -**** ****`api.ionos.com`****, the environment variable**** ****`IONOS_API_URL`**** ****can be set, and used with**** ****`NewConfigurationFromEnv()`**** \*\*\*\*function.*** ## Examples Examples for creating resources using the Go SDK can be found [here](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/examples/README.md) ## Authentication All available server URLs are: * ** - Frankfurt By default, ** is used, however this can be overriden at authentication, either by setting the `IONOS_API_URL` environment variable or by specifying the `hostUrl` parameter when initializing the sdk client. **NOTE**: We recommend passing the URL without the `https://` or `http://` prefix. The SDK checks and adds it if necessary when configurations are created using `NewConfiguration` or `NewConfigurationFromEnv`. This is to avoid issues caused by typos in the prefix that cannot be easily detected and debugged. ### Basic Authentication * **Type**: HTTP basic authentication Example ```golang import ( "context" "fmt" "github.com/ionos-cloud/sdk-go-bundle/shared" cdn "github.com/ionos-cloud/sdk-go-bundle/products/cdn" "log" ) func basicAuthExample() error { cfg := shared.NewConfiguration("username_here", "pwd_here", "", "hostUrl_here") cfg.LogLevel = Trace apiClient := cdn.NewAPIClient(cfg) return nil } ``` ### Token Authentication There are 2 ways to generate your token: ### Generate token using sdk for [auth](https://github.com/ionos-cloud/sdk-go-bundle/products/auth): ```golang import ( "context" "fmt" "github.com/ionos-cloud/sdk-go-bundle/products/auth" "github.com/ionos-cloud/sdk-go-bundle/shared" cdn "github.com/ionos-cloud/sdk-go-bundle/products/cdn" "log" ) func TokenAuthExample() error { //note: to use NewConfigurationFromEnv(), you need to previously set IONOS_USERNAME and IONOS_PASSWORD as env variables authClient := auth.NewAPIClient(authApi.NewConfigurationFromEnv()) jwt, _, err := auth.TokensApi.TokensGenerate(context.Background()).Execute() if err != nil { return fmt.Errorf("error occurred while generating token (%w)", err) } if !jwt.HasToken() { return fmt.Errorf("could not generate token") } cfg := shared.NewConfiguration("", "", *jwt.GetToken(), "hostUrl_here") cfg.LogLevel = Trace apiClient := cdn.NewAPIClient(cfg) return nil } ``` ### Generate token using ionosctl: Install ionosctl as explained [here](https://github.com/ionos-cloud/ionosctl) Run commands to login and generate your token. ```golang ionosctl login ionosctl token generate export IONOS_TOKEN="insert_here_token_saved_from_generate_command" ``` Save the generated token and use it to authenticate: ```golang import ( "context" "fmt" "github.com/ionos-cloud/sdk-go-bundle/products/auth" cdn "github.com/ionos-cloud/sdk-go-bundle/products/cdn" "log" ) func TokenAuthExample() error { //note: to use NewConfigurationFromEnv(), you need to previously set IONOS_TOKEN as env variables authClient := auth.NewAPIClient(authApi.NewConfigurationFromEnv()) cfg.LogLevel = Trace apiClient := cdn.NewAPIClient(cfg) return nil } ``` ## Certificate pinning: You can enable certificate pinning if you want to bypass the normal certificate checking procedure, by doing the following: Set env variable IONOS\_PINNED\_CERT=\ You can get the sha256 fingerprint most easily from the browser by inspecting the certificate. ### Depth Many of the *List* or *Get* operations will accept an optional *depth* argument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, but it generally follows this pattern. By default, the SDK sets the *depth* argument to the maximum value. | Depth | Description | | ----- | ----------------------------------------------------------------------------------- | | 0 | Only direct properties are included. Children are not included. | | 1 | Direct properties and children's references are returned. | | 2 | Direct properties and children's properties are returned. | | 3 | Direct properties, children's properties, and descendants' references are returned. | | 4 | Direct properties, children's properties, and descendants' properties are returned. | | 5 | Returns all available properties. | ### Changing the base URL Base URL for the HTTP operation can be changed by using the following function: ```go requestProperties.SetURL("https://api.ionos.com/cloudapi/v6") ``` ## Debugging You can inject any logger that implements Printf as a logger instead of using the default sdk logger. There are log levels that you can set: `Off`, `Debug` and `Trace`. `Off` - does not show any logs `Debug` - regular logs, no sensitive information `Trace` - we recommend you only set this field for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application's performance. ```golang package main import ( cdn "github.com/ionos-cloud/sdk-go-bundle/products/cdn" "github.com/ionos-cloud/sdk-go-bundle/shared" "github.com/sirupsen/logrus" ) func main() { // create your configuration. replace username, password, token and url with correct values, or use NewConfigurationFromEnv() // if you have set your env variables as explained above cfg := shared.NewConfiguration("username", "password", "token", "hostUrl") // enable request and response logging. this is the most verbose loglevel shared.SdkLogLevel = Trace // inject your own logger that implements Printf shared.SdkLogger = logrus.New() // create you api client with the configuration apiClient := cdn.NewAPIClient(cfg) } ``` ## Documentation for API Endpoints All URIs are relative to **
API Endpoints table | Class | Method | HTTP request | Description | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | -------------------------- | | DistributionsApi | [**DistributionsDelete**](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/api/DistributionsApi.md#distributionsdelete) | **Delete** /distributions/{distributionId} | Delete Distribution | | DistributionsApi | [**DistributionsFindById**](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/api/DistributionsApi.md#distributionsfindbyid) | **Get** /distributions/{distributionId} | Retrieve Distribution | | DistributionsApi | [**DistributionsGet**](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/api/DistributionsApi.md#distributionsget) | **Get** /distributions | Retrieve all Distributions | | DistributionsApi | [**DistributionsPost**](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/api/DistributionsApi.md#distributionspost) | **Post** /distributions | Create Distribution | | DistributionsApi | [**DistributionsPut**](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/api/DistributionsApi.md#distributionsput) | **Put** /distributions/{distributionId} | Ensure Distribution |
## Documentation For Models All URIs are relative to **
API models list * [Distribution](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Distribution/README.md) * [DistributionCreate](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/DistributionCreate/README.md) * [DistributionMetadata](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/DistributionMetadata/README.md) * [DistributionProperties](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/DistributionProperties/README.md) * [DistributionUpdate](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/DistributionUpdate/README.md) * [Distributions](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Distributions/README.md) * [DistributionsAllOf](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/DistributionsAllOf/README.md) * [Error](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Error/README.md) * [ErrorMessages](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/ErrorMessages/README.md) * [IpAddresses](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/IpAddresses/README.md) * [Links](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Links/README.md) * [Metadata](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Metadata/README.md) * [Pagination](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Pagination/README.md) * [ResourceState](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/ResourceState/README.md) * [RoutingRule](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/RoutingRule/README.md) * [Upstream](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/Upstream/README.md) * [UpstreamGeoRestrictions](https://github.com/ionos-cloud/sdk-go-bundle/blob/summary/products/cdn/docs/models/UpstreamGeoRestrictions/README.md) [\[Back to API list\]](#documentation-for-api-endpoints) [\[Back to Model list\]](#documentation-for-models)