Welcome to the 4b42 API! Our API allows you to easily access your 4b42 account, get information about your products.

Our API is continuously being developed and improved, but we are still trying to keep it as stable as possible. We try to only have changes that are backwards compatible: usually the changes are only additions, e.g. new resources are implemented or new properties are added to existing resources. Sometimes breaking changes cannot be avoided, e.g. when a new feature requires an incompatible change to the underlying data model, all those changes will be documented in the change log.

We use the following methods for our api:

When an error is encountered you will receive an HTTP status code along with a message and error code in the body of the response. The message is intended to give a user-friendly explanation of the error while the error codes are designed to be machine readable codes that applications can use to better understand the context of the error and react appropriately.

We use the following status codes for errors:

Status Codes

Error Codes

2018-05-17 Group functions added
Functions added to manage (create,delete,lists and modify) groups of customers.

2018-03-09 Order over API must be granted
Now orders over the API can only made, if the option was enabled. This can be made on our website under access.

2018-03-08 Order Backup added
Added backup products to API.

2018-03-03 API Authentication
Updated authentication to support multible tokens with path and method permissions.

2018-03-02 API Error Codes defined
Defined API error codes for authentication, methods and paths.

2018-01-28 Tools Blacklist added
Created functions for domain and ip-address blacklist.

2017-11-24 Customer functions added
Added function GET to list all customers and details of a customer, added POST to create new customers and DELETE to remove customers

2017-04-14 API Authentication
Added API key authentication to our api.

2017-03-27 API Structure and Overview
Created the basic API structure, overview navication and content.

All requests to the 4b42 API must be authenticated via API key. Include your secret API key in every request you send to the API with the 4b42-KEY HTTP header.

API Key

Once you have the 4b42 apie key, you can make the request to the api. To do this, add your api key to the request header.

To create a new API key for your project, visit the 4b42 website choose access, go to tokens, and create a new token.

GET Records

List all available Domain Name System Records from specific dns zone

[
    {
        "id": "5a11c4936ba6a",
        "dest": "10.48.42.61",
        "host": "@",
        "name": "@",
        "type": "A"
    },
    {
        "id": "5a11c49b60bdc",
        "dest": "@",
        "host": "www",
        "name": "www",
        "type": "CNAME"
    }
]

Parameter

GET Record Types

List all available types for dns records

[
    "A",
    "CNAME",
    "PTR",
    "MX",
    "AAAA",
    "TXT",
    "SRV",
    "TLSA"
]

GET Record

List details of specific dns record

{
    "id": "5a11c49b60bdc",
    "created": "0000-00-00 00:00:00",
    "dest": "@",
    "host": "www",
    "pass": "",
    "port": "",
    "priority": "",
    "updated": "0000-00-00 00:00:00",
    "ttl": "300",
    "type": "CNAME",
    "valid": "yes",
    "weight": ""
}

Parameter

POST Record

Create new dns record

"5aaa93479e3f1"

Parameter

PUT Record

Update dns record

{
    "type": "A",
    "host": "mail",
    "pri": false,
    "weight": false,
    "port": false,
    "dest": "10.48.42.10",
    "ttl": false
}

Parameter

GET Zones

List all available Domain Name System Zones

[
    {
        "created": "2020-02-02 02:02:02",
        "id": "4b42.com",
        "updated": "2020-11-11 11:11:11",
        "valid": "yes"
    },
    {
        "created": "2000-01-01 00:00:00",
        "id": "4b42.com",
        "updated": "2000-02-02 00:00:00",
        "valid": "yes"
    }
]

GET Zone

List all available Domain Name System Zones

{
    "id": "4b42.com",
    "created": "2018-03-03 03:03:03",
    "dnssec": "0",
    "expire": "3600000",
    "hostmaster": "hostmaster.4b42.com",
    "refresh": "86400",
    "retry": "7200",
    "serial": "2018030301",
    "ttl": "172800",
    "updated": "2018-03-03 03:03:03",
    "valid": "yes"
}

Parameter

GET asset

List all autonomous system numbers verified

[
    64496,
    64511
]

Parameter

POST asset

Add an autonomous system number to our AS-SET (verification requried!)

{
    "status": 200,
    "message": "Verification email send to [email protected]"
}

Parameter

PUT tunnel

Update dns zone details, returns updated fields

{
    "endpoint": "198.51.100.51",
    "protocol": "sit"
}

Parameter