Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.
/accounts/{account_identifier}/magic/routes
post
Magic Static Routes
magic-static-routes-create-routes
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}{
"enum": [
"#organization:edit"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"required": [
"prefix",
"nexthop",
"priority"
]
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"routes": {
"items": {
"properties": {
"created_on": {
"description": "When the route was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional human provided description of the static route.",
"example": "New route for new prefix 203.0.113.1",
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "When the route was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"nexthop": {
"description": "The next-hop IP Address for the static route.",
"example": "203.0.113.1",
"type": "string"
},
"prefix": {
"description": "IP Prefix in Classless Inter-Domain Routing format.",
"example": "192.0.2.0/24",
"type": "string"
},
"priority": {
"description": "Priority of the static route.",
"type": "integer"
},
"scope": {
"description": "Used only for ECMP routes.",
"properties": {
"colo_names": {
"description": "List of colo names for the ECMP scope.",
"items": {
"description": "Scope colo name.",
"example": "den01",
"type": "string"
},
"type": "array"
},
"colo_regions": {
"description": "List of colo regions for the ECMP scope.",
"items": {
"description": "Scope colo region.",
"example": "APAC",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"weight": {
"description": "Optional weight of the ECMP scope - if provided.",
"type": "integer"
}
},
"required": [
"prefix",
"nexthop",
"priority"
],
"type": "object"
},
"type": "array"
}
}
}
}
}
]
}
}
},
"description": "Create Routes response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"routes": {
"items": {
"properties": {
"created_on": {
"description": "When the route was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional human provided description of the static route.",
"example": "New route for new prefix 203.0.113.1",
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "When the route was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"nexthop": {
"description": "The next-hop IP Address for the static route.",
"example": "203.0.113.1",
"type": "string"
},
"prefix": {
"description": "IP Prefix in Classless Inter-Domain Routing format.",
"example": "192.0.2.0/24",
"type": "string"
},
"priority": {
"description": "Priority of the static route.",
"type": "integer"
},
"scope": {
"description": "Used only for ECMP routes.",
"properties": {
"colo_names": {
"description": "List of colo names for the ECMP scope.",
"items": {
"description": "Scope colo name.",
"example": "den01",
"type": "string"
},
"type": "array"
},
"colo_regions": {
"description": "List of colo regions for the ECMP scope.",
"items": {
"description": "Scope colo region.",
"example": "APAC",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"weight": {
"description": "Optional weight of the ECMP scope - if provided.",
"type": "integer"
}
},
"required": [
"prefix",
"nexthop",
"priority"
],
"type": "object"
},
"type": "array"
}
}
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Create Routes response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]