Quick API Reference

Quick API Reference

This page gives a high-level map of the DE-CIX API, grouped the same way as our full API reference. For complete details — parameters, request/response bodies, and authentication — always refer to our DE-CIX API Documentation (Postman).

DE-CIX API Documentation (Postman): https://api-docs.de-cix.net/

Authentication

Obtain and refresh your access token. All endpoints (except the token endpoint itself) require a Bearer token.

IX-API Core — standard resources following the open IX-API standard

  • Accounts, Contacts, Role Assignments, Roles, Member Joining Rules
  • Facilities, Devices, POPs, Metro Areas, Metro Area Networks
  • Ports, Port Reservations, Connections
  • IPs, MACs
  • Network Features, Network Feature Configs
  • Network Services, Network Service Configs — the service instance you order (e.g. exchange_lan for GlobePEER, p2p_vc for VirtualPNI, cloud_vc for DirectCLOUD) and your specific configuration on it (VLAN, IP, capacity)
  • Product Offerings — the catalog of services and capacities available to order at a given location

CloudRouter Extension — DE-CIX's implementation for virtual routing (VRF) management

  • VRFs and VRF Network Service Configs (create, read, update, delete)
  • Policies and Prefix Lists (define and attach inbound/outbound filtering)
  • Static Routes and route aggregation
  • Quotas and Product Offerings (CloudRouter)
  • Routing visibility: Advertised Routes, Received Routes, VRF Routes, VRF ARP Table, IP Neighbors, Prefixes
  • Session monitoring: BGP State, BFD State
  • VRF NSC Export (re-export configuration to a switch)

For the complete reference — including all parameters, example requests/responses, and authentication details — see our DE-CIX API Documentation (Postman): https://api-docs.de-cix.net/

Most-used Cloud ROUTER endpoints at a glance

Feature

Endpoint

Description

All Routes

/api/v3/decix-vrf-v1/routes

Retrieve all routes for a specific VRF.

Advertised Routes

/advertised-routes

View prefixes advertised to external peers.

Received Routes

/received-routes

View prefixes learned from external peers.

Create VRF

/api/v3/decix-vrf-v1

Create a new VRF for routing configuration.

Update VRF State

/network-service-configs/{network_service_config}

Enable or disable BGP and related features.

Most-used DirectCLOUD & VirtualPNI endpoints at a glance

Feature

Endpoint

Description

Create Network Service

/api/v2/network-services

Create a new cloud or peering connection (DirectCLOUD, VirtualPNI).

Create Network Service Config

/api/v3/decix-vrf-v1/network-service-configs

Configure the connection (VLAN, IP, capacity).

BGP State

/network-service-configs/{vrf_nsc_id}/bgp-state

Check current BGP session status for the connection.

BFD State

/network-service-configs/{vrf_nsc_id}/bfd-state

Check current BFD session status for the connection.

Delete Network Service Config

/network-service-configs/{id}

Remove a connection configuration.

How did we do?

Overview DE-CIX API

Cloud ROUTER Postman Collection

Get in touch