GET /api/subnets
Lista de subredes

GET /api/domains/:domain_id/subnets
Listarr subredes para un dominio

GET /api/locations/:location_id/subnets
Lista de subredes por ubicación

GET /api/organizations/:organization_id/subnets
Lista de subredes por organización

Ejemplos

GET /api/subnets
200
{
  "total": 7,
  "subtotal": 7,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "network": "2.3.4.0",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": 41,
      "mtu": 1500,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 980190962,
      "name": "one",
      "description": null,
      "network_address": "2.3.4.0/24",
      "dhcp_id": 980190962,
      "dhcp_name": "DHCP Proxy",
      "tftp_id": 298486374,
      "tftp_name": "TFTP Proxy",
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": 113629430,
      "template_id": null,
      "template_name": null,
      "dhcp": {
        "name": "DHCP Proxy",
        "id": 980190962,
        "url": "https://somewhere.net:8443"
      },
      "tftp": {
        "name": "TFTP Proxy",
        "id": 298486374,
        "url": "http://somewhere.else"
      },
      "httpboot": null,
      "dns": {
        "name": "DNS Proxy",
        "id": 113629430,
        "url": "http://else.where:45671"
      },
      "template": null
    },
    {
      "network": "3.3.4.0",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": 42,
      "mtu": 1496,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 298486374,
      "name": "two",
      "description": null,
      "network_address": "3.3.4.0/24",
      "dhcp_id": 980190962,
      "dhcp_name": "DHCP Proxy",
      "tftp_id": 298486374,
      "tftp_name": "TFTP Proxy",
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": null,
      "template_id": null,
      "template_name": null,
      "dhcp": {
        "name": "DHCP Proxy",
        "id": 980190962,
        "url": "https://somewhere.net:8443"
      },
      "tftp": {
        "name": "TFTP Proxy",
        "id": 298486374,
        "url": "http://somewhere.else"
      },
      "httpboot": null,
      "dns": null,
      "template": null
    },
    {
      "network": "3.3.4.3",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": 43,
      "mtu": 1500,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 113629430,
      "name": "three",
      "description": null,
      "network_address": "3.3.4.3/24",
      "dhcp_id": 980190962,
      "dhcp_name": "DHCP Proxy",
      "tftp_id": 298486374,
      "tftp_name": "TFTP Proxy",
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": null,
      "template_id": null,
      "template_name": null,
      "dhcp": {
        "name": "DHCP Proxy",
        "id": 980190962,
        "url": "https://somewhere.net:8443"
      },
      "tftp": {
        "name": "TFTP Proxy",
        "id": 298486374,
        "url": "http://somewhere.else"
      },
      "httpboot": null,
      "dns": null,
      "template": null
    },
    {
      "network": "3.3.5.0",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": 44,
      "mtu": 9000,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 281110143,
      "name": "four",
      "description": null,
      "network_address": "3.3.5.0/24",
      "dhcp_id": null,
      "dhcp_name": null,
      "tftp_id": 298486374,
      "tftp_name": "TFTP Proxy",
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": null,
      "template_id": null,
      "template_name": null,
      "dhcp": null,
      "tftp": {
        "name": "TFTP Proxy",
        "id": 298486374,
        "url": "http://somewhere.else"
      },
      "httpboot": null,
      "dns": null,
      "template": null
    },
    {
      "network": "2001:db10:7::",
      "network_type": "IPv6",
      "cidr": 64,
      "mask": "ffff:ffff:ffff:ffff::",
      "priority": null,
      "vlanid": 44,
      "mtu": 9000,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 374648174,
      "name": "seven",
      "description": null,
      "network_address": "2001:db10:7::/64",
      "dhcp_id": null,
      "dhcp_name": null,
      "tftp_id": null,
      "tftp_name": null,
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": 113629430,
      "template_id": null,
      "template_name": null,
      "dhcp": null,
      "tftp": null,
      "httpboot": null,
      "dns": {
        "name": "DNS Proxy",
        "id": 113629430,
        "url": "http://else.where:45671"
      },
      "template": null
    },
    {
      "network": "2001:db10::",
      "network_type": "IPv6",
      "cidr": 64,
      "mask": "ffff:ffff:ffff:ffff::",
      "priority": null,
      "vlanid": null,
      "mtu": 1500,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 51848956,
      "name": "six",
      "description": null,
      "network_address": "2001:db10::/64",
      "dhcp_id": null,
      "dhcp_name": null,
      "tftp_id": null,
      "tftp_name": null,
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": 113629430,
      "template_id": null,
      "template_name": null,
      "dhcp": null,
      "tftp": null,
      "httpboot": null,
      "dns": {
        "name": "DNS Proxy",
        "id": 113629430,
        "url": "http://else.where:45671"
      },
      "template": null
    },
    {
      "network": "10.0.0.0",
      "network_type": "IPv4",
      "cidr": 24,
      "mask": "255.255.255.0",
      "priority": null,
      "vlanid": null,
      "mtu": 1500,
      "gateway": null,
      "dns_primary": null,
      "dns_secondary": null,
      "from": null,
      "to": null,
      "created_at": "2019-11-07 08:37:37 UTC",
      "updated_at": "2019-11-07 08:37:37 UTC",
      "ipam": "None",
      "boot_mode": "DHCP",
      "id": 1018350795,
      "name": "five",
      "description": null,
      "network_address": "10.0.0.0/24",
      "dhcp_id": 980190962,
      "dhcp_name": "DHCP Proxy",
      "tftp_id": 298486374,
      "tftp_name": "TFTP Proxy",
      "httpboot_id": null,
      "httpboot_name": null,
      "dns_id": 113629430,
      "template_id": null,
      "template_name": null,
      "dhcp": {
        "name": "DHCP Proxy",
        "id": 980190962,
        "url": "https://somewhere.net:8443"
      },
      "tftp": {
        "name": "TFTP Proxy",
        "id": 298486374,
        "url": "http://somewhere.else"
      },
      "httpboot": null,
      "dns": {
        "name": "DNS Proxy",
        "id": 113629430,
        "url": "http://else.where:45671"
      },
      "template": null
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
domain_id
opcional

ID del dominio

Validations:

  • Must be a String

location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
boot_mode string
dns_primary string
dns_secondary string
domain string
gateway string
ipam string
location string
location_id integer
mask string
mtu integer
name text
network string
nic_delay integer
organization string
organization_id integer
params text
type string
vlanid integer

GET /api/subnets/:id
Mostrar una subred

Ejemplos

GET /api/subnets/980190962-one
200
{
  "network": "2.3.4.0",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": 41,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2019-11-07 08:37:37 UTC",
  "updated_at": "2019-11-07 08:37:37 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "id": 980190962,
  "name": "one",
  "description": null,
  "network_address": "2.3.4.0/24",
  "dhcp_id": 980190962,
  "dhcp_name": "DHCP Proxy",
  "tftp_id": 298486374,
  "tftp_name": "TFTP Proxy",
  "httpboot_id": null,
  "httpboot_name": null,
  "dns_id": 113629430,
  "template_id": null,
  "template_name": null,
  "dhcp": {
    "name": "DHCP Proxy",
    "id": 980190962,
    "url": "https://somewhere.net:8443"
  },
  "tftp": {
    "name": "TFTP Proxy",
    "id": 298486374,
    "url": "http://somewhere.else"
  },
  "httpboot": null,
  "dns": {
    "name": "DNS Proxy",
    "id": 113629430,
    "url": "http://else.where:45671"
  },
  "template": null,
  "domains": [
    {
      "id": 22495316,
      "name": "mydomain.net"
    }
  ],
  "interfaces": [],
  "parameters": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
opcional

Mostrar valores de parámetros ocultos

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/subnets
Crear una subred

Ejemplos

POST /api/subnets
{
  "subnet": {
    "name": "QA2",
    "network_type": "IPv6",
    "network": "2001:db8::",
    "mask": "ffff:ffff:ffff:ffff::",
    "ipam": "None"
  }
}
201
{
  "network": "2001:db8::",
  "network_type": "IPv6",
  "cidr": 64,
  "mask": "ffff:ffff:ffff:ffff::",
  "priority": null,
  "vlanid": null,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2019-11-07 08:38:14 UTC",
  "updated_at": "2019-11-07 08:38:14 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "id": 1018350830,
  "name": "QA2",
  "description": null,
  "network_address": "2001:db8::/64",
  "dhcp_id": null,
  "dhcp_name": null,
  "tftp_id": null,
  "tftp_name": null,
  "httpboot_id": null,
  "httpboot_name": null,
  "dns_id": null,
  "template_id": null,
  "template_name": null,
  "dhcp": null,
  "tftp": null,
  "httpboot": null,
  "dns": null,
  "template": null,
  "domains": [],
  "interfaces": [],
  "parameters": [],
  "locations": [],
  "organizations": []
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

subnet
requerido

Validations:

  • Must be a Hash

subnet[name]
requerido

Nombre de subred

Validations:

  • Must be a String

subnet[description]
opcional , nil permitido

Descripción de subred

Validations:

  • Must be a String

subnet[network_type]
opcional , nil permitido

Tipo o protocolo, IPv4 o IPv6, se predetermina en IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
requerido

Red de subred

Validations:

  • Must be a String

subnet[mask]
requerido

Máscara para esta subred

Validations:

  • Must be a String

subnet[gateway]
opcional , nil permitido

Gateway de subred

Validations:

  • Must be a String

subnet[dns_primary]
opcional , nil permitido

DNS primaria para esta subred

Validations:

  • Must be a String

subnet[dns_secondary]
opcional , nil permitido

DNS secundaria para esta subred

Validations:

  • Must be a String

subnet[ipam]
opcional , nil permitido

Método por el que se sugiere la dirección IP en esta subred, valores válidos son “DHCP”, “Internal DB”, “None”

Validations:

  • Must be a String

subnet[from]
opcional , nil permitido

Dirección IP de inicio para autosugerencia de IP

Validations:

  • Must be a String

subnet[to]
opcional , nil permitido

Dirección IP final para sugerencias

Validations:

  • Must be a String

subnet[vlanid]
opcional , nil permitido

ID de VLAN para esta subred

Validations:

  • Must be a String

subnet[mtu]
opcional , nil permitido

MTU de esta subred

Validations:

  • Must be a Integer

subnet[domain_ids]
opcional , nil permitido

Dominios a los que pertenece esta subred

Validations:

  • Must be an array of any type

subnet[dhcp_id]
opcional , nil permitido

ID de proxy DHCP para usar con esta subred

Validations:

  • Must be a number.

subnet[tftp_id]
opcional , nil permitido

ID de proxy TFTP para usar con esta subred

Validations:

  • Must be a number.

subnet[httpboot_id]
opcional , nil permitido

ID de Proxy HTTPBoot para usar dentro de esta subred

Validations:

  • Must be a number.

subnet[dns_id]
opcional , nil permitido

ID de proxy DNS para usar con esta subred

Validations:

  • Must be a number.

subnet[template_id]
opcional , nil permitido

ID de proxy HTTP(S) de plantilla para utilizar dentro de esta subred

Validations:

  • Must be a number.

subnet[boot_mode]
opcional , nil permitido

Modo de arranque predeterminado para interfaces asignadas a esta subred, son válidos “Static”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type

subnet[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

subnet[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
Actualizar una subred

Ejemplos

PUT /api/subnets/1018350829
{
  "subnet": {
    "subnet_parameters_attributes": [
      {
        "name": "new_key",
        "value": "new_value"
      }
    ]
  }
}
200
{
  "network": "135.31.20.0",
  "network_type": "IPv4",
  "cidr": 24,
  "mask": "255.255.255.0",
  "priority": null,
  "vlanid": null,
  "mtu": 1500,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "created_at": "2019-11-07 08:38:14 UTC",
  "updated_at": "2019-11-07 08:38:14 UTC",
  "ipam": "None",
  "boot_mode": "DHCP",
  "id": 1018350829,
  "name": "subnet116",
  "description": null,
  "network_address": "135.31.20.0/24",
  "dhcp_id": null,
  "dhcp_name": null,
  "tftp_id": null,
  "tftp_name": null,
  "httpboot_id": null,
  "httpboot_name": null,
  "dns_id": null,
  "template_id": null,
  "template_name": null,
  "dhcp": null,
  "tftp": null,
  "httpboot": null,
  "dns": null,
  "template": null,
  "domains": [],
  "interfaces": [],
  "parameters": [
    {
      "priority": 40,
      "created_at": "2019-11-07 08:38:14 UTC",
      "updated_at": "2019-11-07 08:38:14 UTC",
      "id": 767575245,
      "name": "new_key",
      "parameter_type": "string",
      "value": "new_value"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Identificador numérico de subred

Validations:

  • Must be a number.

subnet
requerido

Validations:

  • Must be a Hash

subnet[name]
opcional

Nombre de subred

Validations:

  • Must be a String

subnet[description]
opcional , nil permitido

Descripción de subred

Validations:

  • Must be a String

subnet[network_type]
opcional , nil permitido

Tipo o protocolo, IPv4 o IPv6, se predetermina en IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
opcional

Red de subred

Validations:

  • Must be a String

subnet[mask]
opcional

Máscara para esta subred

Validations:

  • Must be a String

subnet[gateway]
opcional , nil permitido

Gateway de subred

Validations:

  • Must be a String

subnet[dns_primary]
opcional , nil permitido

DNS primaria para esta subred

Validations:

  • Must be a String

subnet[dns_secondary]
opcional , nil permitido

DNS secundaria para esta subred

Validations:

  • Must be a String

subnet[ipam]
opcional , nil permitido

Método por el que se sugiere la dirección IP en esta subred, valores válidos son “DHCP”, “Internal DB”, “None”

Validations:

  • Must be a String

subnet[from]
opcional , nil permitido

Dirección IP de inicio para autosugerencia de IP

Validations:

  • Must be a String

subnet[to]
opcional , nil permitido

Dirección IP final para sugerencias

Validations:

  • Must be a String

subnet[vlanid]
opcional , nil permitido

ID de VLAN para esta subred

Validations:

  • Must be a String

subnet[mtu]
opcional , nil permitido

MTU de esta subred

Validations:

  • Must be a Integer

subnet[domain_ids]
opcional , nil permitido

Dominios a los que pertenece esta subred

Validations:

  • Must be an array of any type

subnet[dhcp_id]
opcional , nil permitido

ID de proxy DHCP para usar con esta subred

Validations:

  • Must be a number.

subnet[tftp_id]
opcional , nil permitido

ID de proxy TFTP para usar con esta subred

Validations:

  • Must be a number.

subnet[httpboot_id]
opcional , nil permitido

ID de Proxy HTTPBoot para usar dentro de esta subred

Validations:

  • Must be a number.

subnet[dns_id]
opcional , nil permitido

ID de proxy DNS para usar con esta subred

Validations:

  • Must be a number.

subnet[template_id]
opcional , nil permitido

ID de proxy HTTP(S) de plantilla para utilizar dentro de esta subred

Validations:

  • Must be a number.

subnet[boot_mode]
opcional , nil permitido

Modo de arranque predeterminado para interfaces asignadas a esta subred, son válidos “Static”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type

subnet[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

subnet[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
Borrar una subred

Ejemplos

DELETE /api/subnets/281110143-four
{
  "subnet": {}
}
200
{
  "id": 281110143,
  "network": "3.3.5.0",
  "mask": "255.255.255.0",
  "priority": null,
  "name": "four",
  "vlanid": 44,
  "created_at": "2019-11-07T08:37:37.209Z",
  "updated_at": "2019-11-07T08:37:37.209Z",
  "dhcp_id": null,
  "tftp_id": 298486374,
  "gateway": null,
  "dns_primary": null,
  "dns_secondary": null,
  "from": null,
  "to": null,
  "dns_id": null,
  "boot_mode": "DHCP",
  "ipam": "None",
  "description": null,
  "mtu": 9000,
  "template_id": null,
  "httpboot_id": null,
  "nic_delay": null,
  "to_label": "four (3.3.5.0/24)",
  "type": "Subnet::Ipv4"
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Identificador numérico de subred

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
Proporciona una dirección IP no utilizada en esta subred

Ejemplos

GET /api/subnets/1018350798-subnet186/freeip
200
{
  "freeip": null,
  "errors": {}
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

mac
opcional

Dirección MAC para reutilizar la IP de este host

Validations:

  • Must be a String

excluded_ips
opcional

Direcciones IP que deben excluirse de la sugerencia

Validations:

  • Must be an array of any type