List Service Keys

GET

/v2/service/key

GET

/v2/service/key

curl https://api.megaport.com/v2/service/key

{
  "data": [
    {
      "active": true,
      "bEnd": {},
      "companyId": 1153,
      "companyName": "Megaport Lab",
      "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
      "createDate": 1738027647205,
      "description": "SK1",
      "expired": false,
      "key": "29ff7f32-c19a-4ced-b4e1-4f796b213b6f",
      "lastUsed": null,
      "maxSpeed": 10000,
      "preApproved": true,
      "productId": 226855,
      "productName": "Example Port",
      "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
      "singleUse": false,
      "valid": true,
      "validFor": {
        "end": 1740619635209,
        "start": 1738027646696
      },
      "vlan": null
    },
    {
      "active": true,
      "bEnd": {},
      "companyId": 1153,
      "companyName": "Megaport Lab",
      "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
      "createDate": 1738027665841,
      "description": "SK2",
      "expired": false,
      "key": "63fcde5c-c87c-478d-bb11-63cbc9541c89",
      "lastUsed": null,
      "maxSpeed": 10000,
      "preApproved": true,
      "productId": 226855,
      "productName": "Example Port",
      "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
      "singleUse": true,
      "valid": true,
      "validFor": {
        "end": 1740619649920,
        "start": 1738027665336
      },
      "vlan": 90
    },
    {
      "active": false,
      "bEnd": {},
      "companyId": 1153,
      "companyName": "Megaport Lab",
      "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
      "createDate": 1738027681118,
      "description": "SK3",
      "expired": false,
      "key": "593a32f0-42cc-419c-94a8-de2057937162",
      "lastUsed": null,
      "maxSpeed": 10000,
      "preApproved": true,
      "productId": 226855,
      "productName": "Example Port",
      "productUid": "73b2a452-9f93-4c45-afa0-887cf7f17e89",
      "singleUse": false,
      "valid": false,
      "validFor": {
        "end": 1740619668495,
        "start": 1738027680699
      },
      "vlan": null
    }
  ],
  "message": "Found [3] service keys for product [73b2a452-9f93-4c45-afa0-887cf7f17e89]",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Lists service keys associated with your account.

Add a service or a specific key to return details only for that value.

The response includes all of the information about a service key, including the creation date, description, VLAN, maximum speed, whether the key is single-use or multi-use, whether it is active, and the dates for which the key is valid.

The dates are returned in UNIX timestamp date format. You can use tools such as https://www.epochconverter.com/ or https://it-tools.tech/date-converter to convert the date to a human-readable format.

Query parameters

productIdOrUidstringOptional

List keys linked to the service specified by the product ID or UID. (Optional)

keystringOptional

Get details for the specified key. (Optional) You can use the first 8 digits of a key, or you can use the full value.

Response

List Service Keys / List Service Keys - Specified Key / List Service Keys / List Service Keys - Specified Key / Look Up SAP Service Key / Look Up SAP Service Key

datalist of objects or objectOptional

messagestringOptional

termsstringOptional