API Reference

Magic Transit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Routes

List Routes

GET/accounts/{account_id}/magic/routes

Route Details

GET/accounts/{account_id}/magic/routes/{route_id}

Create a Route

POST/accounts/{account_id}/magic/routes

Update Route

PUT/accounts/{account_id}/magic/routes/{route_id}

Delete Route

DELETE/accounts/{account_id}/magic/routes/{route_id}

Update Many Routes

PUT/accounts/{account_id}/magic/routes

Delete Many Routes

DELETE/accounts/{account_id}/magic/routes

ModelsExpand Collapse

Scope = object { colo_names, colo_regions }

Used only for ECMP routes.

colo_names: optional array of string

List of colo names for the ECMP scope.

colo_regions: optional array of string

List of colo regions for the ECMP scope.

RouteListResponse = object { routes }

routes: optional array of object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteGetResponse = object { route }

route: optional object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteCreateResponse = object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteUpdateResponse = object { modified, modified_route }

modified: optional boolean

modified_route: optional object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteDeleteResponse = object { deleted, deleted_route }

deleted: optional boolean

deleted_route: optional object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteBulkUpdateResponse = object { modified, modified_routes }

modified: optional boolean

modified_routes: optional array of object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.

RouteEmptyResponse = object { deleted, deleted_routes }

deleted: optional boolean

deleted_routes: optional array of object { id, nexthop, prefix, 6 more }

id: string

Identifier

maxLength32

nexthop: string

The next-hop IP Address for the static route.

prefix: string

IP Prefix in Classless Inter-Domain Routing format.

priority: number

Priority of the static route.

created_on: optional string

When the route was created.

formatdate-time

description: optional string

An optional human provided description of the static route.

modified_on: optional string

When the route was last modified.

formatdate-time

scope: optional Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight: optional number

Optional weight of the ECMP scope - if provided.