freemyip

README

Go library for accessing the freemyip.com API

An freemyip.com API client written in Go.

freemyip is a Go client library for accessing the freemyip.com API.

Examples

package main

import (
	"context"
	"fmt"

	"github.com/nrdcg/freemyip"
)

func main() {
	client := freemyip.New("secret", true)

	ctx := context.Background()

	resp, err := client.UpdateDomain(ctx, "example", "")
	if err != nil {
		panic(err)
	}

	fmt.Println(resp)
}

API Documentation

• API docs

Documentation

Overview

Package freemyip contains a client of the DNS API of freemyip.

Index

• Constants
• type Client
  • func New(token string, verbose bool) *Client
  • func (c Client) DeleteDomain(ctx context.Context, domain string) (string, error)
  • func (c Client) DeleteTXTRecord(ctx context.Context, domain string) (string, error)
  • func (c Client) EditTXTRecord(ctx context.Context, domain, value string) (string, error)
  • func (c Client) UpdateDomain(ctx context.Context, domain, myIP string) (string, error)

Constants

const RootDomain = "freemyip.com"

RootDomain the root domain of all domains.

Types

type Client

type Client struct {
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

Client an API client for freemyip.

func New

func New(token string, verbose bool) *Client

New creates a new Client.

func (Client) DeleteDomain

func (c Client) DeleteDomain(ctx context.Context, domain string) (string, error)

DeleteDomain deletes a domain.

• `domain` is the custom part of the real domain. (ex: `YOUR_DOMAIN` in `YOUR_DOMAIN.freemyip.com`)

func (Client) DeleteTXTRecord

func (c Client) DeleteTXTRecord(ctx context.Context, domain string) (string, error)

DeleteTXTRecord delete a TXT record for a domain.

• `domain` is the custom part of the real domain. (ex: `YOUR_DOMAIN` in `YOUR_DOMAIN.freemyip.com`)
• `value` is the TXT record content.

func (Client) EditTXTRecord

func (c Client) EditTXTRecord(ctx context.Context, domain, value string) (string, error)

EditTXTRecord creates or updates a TXT record value for a domain.

• `domain` is the custom part of the real domain. (ex: `YOUR_DOMAIN` in `YOUR_DOMAIN.freemyip.com`)
• `value` is the TXT record content.

func (Client) UpdateDomain

func (c Client) UpdateDomain(ctx context.Context, domain, myIP string) (string, error)

UpdateDomain updates a domain.

• `domain` is the custom part of the real domain. (ex: `YOUR_DOMAIN` in `YOUR_DOMAIN.freemyip.com`)
• `myIP` is optional.