API endpoit /api/v1/devices

El endpoint devices, retorna los dispostivos almacenados en la tabla Devices.


Modelo de Datos

La tabla asociada o Modelo de Datos del endpoint /api/v1/devices se llama Devices, y está compuesta por los siguientes campos:

name (*)
vendor
memory
family

(*) Campos que conforman la Key primaria y única de la tabla.
El campo name, se utiliza como parte de la Key de la tabla Interfaces.



URL

La URL esta formada por el pattern /api/v1/devices.

/api/v1/devices


Métodos

Métodos implementados en el endpoint.

GET


El método GET se utiliza para hacer consultas a las tablas asociadas al endpoint, en este caso, la tabla Devices. GET solo requiere la definición del Header de acuerdo a las exigencias o definición del endpoint en el API Server



Header

Esta sección muestra como definir el Header cuando se configura un call o request al endpoint. Ejemplos para python y CURL.

Python Authorization Token:

Ver tokens

import requests
import json
url = 'http://e-learning.octupus.com/api/v1/devices'
headers = {
'Authorization': 'Token c26b519346e0755bf9b864c0db8d3d36d854ab23',
'Content-Type': 'application/json',
}
response = requests.request("GET", url, headers=headers, data=payload)
print(json.dumps(json.loads(respose.content), indent=3))


Python Authorization Basic:

Ver Usuarios

Basic Authorization usando 'Basic Auth Token' (base64 encoding de user:password)

import requests
import json
url = 'http://e-learning.octupus.com/api/v1/devices'
headers = {
'Authorization': 'Basic b2N0aW9uOk9jdGlvblNlcnZlcg==',
'Content-Type': 'application/json',
}
response = requests.request("GET", url, headers=headers, data=payload)
print(json.dumps(json.loads(respose.content), indent=3))


Basic Authorization usando 'user/password'

import requests
import json
url = 'http://e-learning.octupus.com/api/v1/devices'
user = 'oction'
password = 'OctionServer'
response = requests.get(url, auth=(user, password))
print(json.dumps(json.loads(respose.content), indent=3))


Curl Authorization Token:

Ver Tokens

curl --location --request GET 'http://e-learning.octupus.com/api/v1/devices' \
--header 'Authorization: Token c26b519346e0755bf9b864c0db8d3d36d854ab23' \
--header 'Content-Type: application/json'


Curl Authorization Basic:

Ver Usuarios

Basic Authorization usando 'Basic Auth Token' (base64 encoding de user:password)

curl --location --request GET 'http://e-learning.octupus.com/api/v1/devices' \
--header 'Authorization: Basic b2N0aW9uOk9jdGlvblNlcnZlcg==' \
--header 'Content-Type: application/json'




Body

El método GET no requiere Body



Try it

Try a GET

Código Python Authorization Tokens

import requests
import json
url = 'http://e-learning.octupus.com/api/v1/devices'

headers = {

}

response = requests.request("GET", url, headers=headers)
print(json.dumps(json.loads(respose.content), indent=3))



Output

[
{
"name": "Catalyst 2901",
"memory": 2048,
"vendor": "Cisco Systems",
"family": "Catalyst"
},
{
"name": "Catalyst 3700",
"memory": 4096,
"vendor": "Cisco Systems",
"family": "Catalyst"
},
{
"name": "Cisco CSR1000",
"memory": 4096,
"vendor": "Cisco Systems",
"family": "Routers"
}
]