Skip to content
Start here

Routes

List Routes
magic_transit.routes.list(RouteListParams**kwargs) -> RouteListResponse
GET/accounts/{account_id}/magic/routes
Route Details
magic_transit.routes.get(strroute_id, RouteGetParams**kwargs) -> RouteGetResponse
GET/accounts/{account_id}/magic/routes/{route_id}
Create a Route
magic_transit.routes.create(RouteCreateParams**kwargs) -> RouteCreateResponse
POST/accounts/{account_id}/magic/routes
Update Route
magic_transit.routes.update(strroute_id, RouteUpdateParams**kwargs) -> RouteUpdateResponse
PUT/accounts/{account_id}/magic/routes/{route_id}
Delete Route
magic_transit.routes.delete(strroute_id, RouteDeleteParams**kwargs) -> RouteDeleteResponse
DELETE/accounts/{account_id}/magic/routes/{route_id}
Update Many Routes
magic_transit.routes.bulk_update(RouteBulkUpdateParams**kwargs) -> RouteBulkUpdateResponse
PUT/accounts/{account_id}/magic/routes
Delete Many Routes
magic_transit.routes.empty(RouteEmptyParams**kwargs) -> RouteEmptyResponse
DELETE/accounts/{account_id}/magic/routes
ModelsExpand Collapse
class Scope:

Used only for ECMP routes.

colo_names: Optional[List[str]]

List of colo names for the ECMP scope.

colo_regions: Optional[List[str]]

List of colo regions for the ECMP scope.

class RouteListResponse:
routes: Optional[List[Route]]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteGetResponse:
route: Optional[Route]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteCreateResponse:
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteUpdateResponse:
modified: Optional[bool]
modified_route: Optional[ModifiedRoute]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteDeleteResponse:
deleted: Optional[bool]
deleted_route: Optional[DeletedRoute]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteBulkUpdateResponse:
modified: Optional[bool]
modified_routes: Optional[List[ModifiedRoute]]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.

class RouteEmptyResponse:
deleted: Optional[bool]
deleted_routes: Optional[List[DeletedRoute]]
id: str

Identifier

maxLength32
nexthop: str

The next-hop IP Address for the static route.

prefix: str

IP Prefix in Classless Inter-Domain Routing format.

priority: int

Priority of the static route.

created_on: Optional[datetime]

When the route was created.

formatdate-time
description: Optional[str]

An optional human provided description of the static route.

modified_on: Optional[datetime]

When the route was last modified.

formatdate-time
scope: Optional[Scope]

Used only for ECMP routes.

weight: Optional[int]

Optional weight of the ECMP scope - if provided.