Generar Clave de Servicio

POST

/v2/service/key

POST

/v2/service/key

curl -X POST https://api.megaport.com/v2/service/key \
     -H "Content-Type: application/json" \
     -d '{
  "_set_singleUse_to_false_to_make_service_key_multiUse": true,
  "active": true,
  "description": "Servicio de Documentación Clave - Un Solo Uso",
  "maxSpeed": "500",
  "preApproved": true,
  "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
  "singleUse": true,
  "validFor": {
    "_make_end_timestamp_equal_to_1_month_forward": 1612015200000,
    "_make_start_timestamp_equal_to_now": 1608506197135,
    "end": 1612015200000,
    "start": 1608506197135
  },
  "vlan": 3
}'

200Successful

{
  "data": {
    "active": true,
    "bEnd": {},
    "companyId": 1153,
    "companyName": "Megaport Lab",
    "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
    "createDate": 1738039556254,
    "description": "Servicio de Documentación Clave - Un Solo Uso",
    "expired": true,
    "key": "96cbcd3b-024e-4ea2-9b9f-ebfe5296b979",
    "lastUsed": null,
    "maxSpeed": 500,
    "preApproved": true,
    "productDto": {
      "companyName": "Megaport Lab",
      "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
      "connectType": "DEFAULT",
      "diversityZone": "blue",
      "locationId": 68,
      "portSpeed": 10000,
      "productName": "Example Port",
      "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
      "vxcPermitted": true
    },
    "productId": 226855,
    "productName": "Example Port",
    "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
    "singleUse": true,
    "valid": false,
    "validFor": {
      "end": 1612015200000,
      "start": 1608506197135
    },
    "vlan": 3
  },
  "message": "Nueva clave de servicio [96cbcd3b-024e-4ea2-9b9f-ebfe5296b979] generada",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Crea una clave de servicio.

Antes de poder crear una clave de servicio, necesita un servicio y debe especificar el ID del servicio en el campo productUid de la solicitud.

Personalice el cuerpo de la solicitud con los detalles de configuración para la clave de servicio.

active determina si la clave de servicio está disponible para su uso. Los valores válidos son true si desea que la clave esté disponible inmediatamente y false si no desea que la clave esté disponible inmediatamente. La clave de servicio se puede actualizar más adelante para cambiar este valor.

singleUse determina si se crea una clave de servicio de un solo uso o de uso múltiple. Los valores válidos son true (un solo uso) y false (uso múltiple). Con una clave de uso múltiple, el cliente con el que comparte la clave puede solicitar múltiples conexiones utilizando esa clave. Solo para claves de un solo uso, especifique un ID de VLAN (vlan).

maxSpeed es el límite de velocidad máximo para la clave de servicio en Mbps. Debe ser igual o inferior a 1000. Dejar este valor en blanco limitará la clave de servicio a la velocidad de servicio máxima disponible.

validFor es el rango de fechas para el cual la clave de servicio es válida. Las fechas se ingresan en formato de marca de tiempo UNIX. Puede utilizar herramientas como https://www.epochconverter.com/ o https://it-tools.tech/date-converter para determinar el valor correcto a ingresar.

Para obtener más información, consulte Crear una clave de servicio con la API.

Solicitud

This endpoint expects an object.

_set_singleUse_to_false_to_make_service_key_multiUsebooleanOpcional

activebooleanOpcional

descriptionstringOpcional

maxSpeedstringOpcional

preApprovedbooleanOpcional

productUidstringOpcional

singleUsebooleanOpcional

validForobjectOpcional

vlandoubleOpcional

Respuesta

Generar Clave de Servicio / Generar Clave de Servicio

dataobjectOpcional

messagestringOpcional

termsstringOpcional