API – Knowledgebase

Knowledgebase Contents

Overview

Inter.link develops network automation in an API-first fashion, which means that anything available in the portal is by definition available via the API.

First Steps with Inter.link API

The objective of this guide is to help customers get started with the Inter.link API. The following topics are covered here:

  • Authentication
  • API Explorer
  • API Q&A

Authentication

The Inter.link API uses API keys for accessing the API. In order to obtain a new API key, go to user profile and click on the “API Keys” section. Then click on the “Create API Key” button and enter a name for the new API key. The API key will be displayed after clicking on the “Create” button.

API Explorer

The API reference is available at https://portal.inter.link/api/v1/docs.

First, a customer needs to authenticate themselves by clicking on the “Authorize” button and entering their API key. Then they can start exploring the API.

For example, to view services, navigate to the “Services” section and click on the “GET /services” endpoint. Then click on the “Try it out”. Finally, click on the “Execute” button.

The response will be displayed in the “Response” section.

Image

API Versioning

    The Inter.link API is versioned, and will release a new version if breaking changes are added.

    Customers will have a grace period to implement the new version before it eventually gets removed.

    API Q&A 

    Is there an API endpoint to create a FlexTunnel?

    FlexTunnel services are created through the IP Transit API, not through a dedicated FlexTunnel endpoint.

    To provision a FlexTunnel:

    • Use the IP Transit create endpoint.

    • Set the service type to GRE Tunnel.

    • Provide the customer’s public IP in the peer_ip field.

    • Set outbound advertisement to Outbound Only.

    This configuration provisions a FlexTunnel instance.

    Is there an API endpoint to create DDoS Protection services?

    Yes, DDoS Protection services can be provisioned via API. If you cannot find the endpoint in the current API documentation, please contact Inter.link support.

    Some endpoints may not yet be listed in public documentation, and we can provide guidance and examples for your specific use case.

    How can a reseller create a sub-customer using the API?

    Resellers can create sub-customers using the Tenants API.

    • Use the /tenants endpoint to create a new tenant.

    • This request can also create the first user for that sub-customer.

    This is the recommended way to provision new customer accounts under a reseller.

    How can additional users be created for a sub-customer via API?

    Additional users must be created while impersonating the sub-customer tenant.

    This is done by:

    • Authenticating as the reseller.

    • Adding an HTTP header (as-tenant) with the tenant ID of the sub-customer.

    • Calling the user creation endpoint.

    This ensures the user is created under the correct customer account.

    Can I use the API to add subnets to a Zone for the DDoS platform?

    This article explains how to authenticate with the Mitigation Portal API and how to add one or more subnets to a zone.

    Generate an API Key

    To generate an API key:

    • Log in to mitigation.center
    • Navigate to Profile
    • Select API key
    • Save the generated token securely. You will use it to authenticate API requests.

    Authentication

    All API requests must include an Authorization header with your API token.

    Header format

    Authorization: token <your_token>

    The keyword token is case-insensitive. The following examples are all valid:

    Authorization: token 6d776df80f7ef2eba4dfd0485c776642
    Authorization: Token 6d776df80f7ef2eba4dfd0485c776642
    Authorization: TOKEN 6d776df80f7ef2eba4dfd0485c776642

    Add Subnets to a Zone

    Endpoint

    POST /zones/:ID/subnets

    URL Parameters

    Name Required Type Description
    :ID Yes URL Parameter The unique numeric ID of the zone to which you want to add subnets.

    Request Body

    The request body must be a JSON object containing a data array with one or more subnet objects.

    Field Required Type Description
    data Yes JSON Array This should contain one or more subnet objects you want to add to the zone.
    subnet Yes JSON String The IP address and subnet mask you wish to change to. Accepts either IPv4 or IPv6 addresses. If the subnet mask is omitted it will default to /32 for IPv4 and /128 for IPv6. The specific subnet and mask used must be unique among all zones in the mitigation platform (you can’t use the same address in two different zones).
    description No JSON String An optional description for the subnet.


    Is there documentation for the mitigation portal API?

    Yes.

    You can access the Mitigation portal API documentation by clicking any of the question marks in the portal while logged in.