API Reference

Magic Transit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Routes

List Routes

client.magicTransit.routes.list(RouteListParams { account_id } params, RequestOptionsoptions?): RouteListResponse { routes }

GET/accounts/{account_id}/magic/routes

Route Details

client.magicTransit.routes.get(stringrouteId, RouteGetParams { account_id } params, RequestOptionsoptions?): RouteGetResponse { route }

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

Create a Route

client.magicTransit.routes.create(RouteCreateParams { account_id, nexthop, prefix, 4 more } params, RequestOptionsoptions?): RouteCreateResponse { id, nexthop, prefix, 6 more }

POST/accounts/{account_id}/magic/routes

Update Route

client.magicTransit.routes.update(stringrouteId, RouteUpdateParams { account_id, nexthop, prefix, 4 more } params, RequestOptionsoptions?): RouteUpdateResponse { modified, modified_route }

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

Delete Route

client.magicTransit.routes.delete(stringrouteId, RouteDeleteParams { account_id } params, RequestOptionsoptions?): RouteDeleteResponse { deleted, deleted_route }

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

Update Many Routes

client.magicTransit.routes.bulkUpdate(RouteBulkUpdateParams { account_id, routes } params, RequestOptionsoptions?): RouteBulkUpdateResponse { modified, modified_routes }

PUT/accounts/{account_id}/magic/routes

Delete Many Routes

client.magicTransit.routes.empty(RouteEmptyParams { account_id } params, RequestOptionsoptions?): RouteEmptyResponse { deleted, deleted_routes }

DELETE/accounts/{account_id}/magic/routes

ModelsExpand Collapse

Scope { colo_names, colo_regions }

Used only for ECMP routes.

colo_names?: Array<string>

List of colo names for the ECMP scope.

colo_regions?: Array<string>

List of colo regions for the ECMP scope.

RouteListResponse { routes }

routes?: Array<Route>

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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteGetResponse { route }

route?: Route { 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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteCreateResponse { 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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteUpdateResponse { modified, modified_route }

modified?: boolean

modified_route?: ModifiedRoute { 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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteDeleteResponse { deleted, deleted_route }

deleted?: boolean

deleted_route?: DeletedRoute { 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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteBulkUpdateResponse { modified, modified_routes }

modified?: boolean

modified_routes?: Array<ModifiedRoute>

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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.

RouteEmptyResponse { deleted, deleted_routes }

deleted?: boolean

deleted_routes?: Array<DeletedRoute>

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?: string

When the route was created.

formatdate-time

description?: string

An optional human provided description of the static route.

modified_on?: string

When the route was last modified.

formatdate-time

scope?: Scope { colo_names, colo_regions }

Used only for ECMP routes.

weight?: number

Optional weight of the ECMP scope - if provided.