Quick Start

Your API requests are authenticated using API tokens. Any request that doesn't include an API token will return an error.

You can generate an API token from your Account at any time: https://packetengine.co.uk/user/api-tokens

Install the library

The best way to interact with our API is to use one of our official libraries:

Go

# Install via go
go mod init
go get github.com/PacketEngine/packetengine

Make your first request

To make your first request, send an authenticated request to the subdomains endpoint. This will fetch all the subdomains of a domain.

Retrieve all subdomains associated with a domain

GET https://api.packetengine.co.uk/v1/domains/{domain}/subdomains

Path Parameters

Name	Type	Description
domain*	String	The domain to fetch subdomains for

Headers

Name	Type	Description
Accept	String	application/json
Accept	String	text/plain

200 {"subdomains":["www.example.com","test.example.com"]}

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

200: OK www.example.com\ntest.example.com

404: Not Found {"error":"Not found"}

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl -s https://api.packetengine.co.uk/v1/domains/uberinternal.com/subdomains
    -H 'Accept: text/plain'
    -H "Authorization: Bearer Your-API-Token" 

Go

// Set your API key and domain before making the request
package main

import (
    "fmt"
    "github.com/PacketEngine/packetengine"
)

var packetengineClient *packetengine.PacketEngineClient

func main() {
   packetengineClient, err := packetengine.NewPacketEngineClient("your_api_token_here")

    if err != nil {
        fmt.Println(err)
        return
    }

    withoutTags := ""
    subdomains, err := packetengineClient.GetSubdomains("example.com", withoutTags)
    if err != nil {
        fmt.Println(err)
        return
    }

    for _, subdomain := range subdomains {
        println(subdomain)
    }
}