SCscanopy
Interfaces

Get interface by ID

Changed on
get/api/v1/interfaces/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/interfaces/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Interface ID

Response

Interface found

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "data": {
    "mac_address": "a4:bb:6d:12:34:56",
    "neighbor_candidates": [
      {
        "cdp_address": "192.168.1.1",
        "lldp_mgmt_addr": "192.168.1.1"
      }
    ]
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c94279effef3Revision changes
    • warning

      added the new Lpd enum value to the /////////// response property for the response status

    • warning

      added the new Lpd enum value to the /////////// response property for the response status

    • warning

      added the new Lpd enum value to the /////////// response property for the response status

    • warning

      added the new Lpd enum value to the /////////// response property for the response status

    • warning

      added the new Lpd enum value to the //////// response property for the response status

    • warning

      added the new Lpd enum value to the //////// response property for the response status

    • warning

      added the new Lpd enum value to the ////////// response property for the response status

    • warning

      added the new Lpd enum value to the ////////// response property for the response status

    • warning

      added the new Lpd enum value to the //////// response property for the response status

    • warning

      added the new Lpd enum value to the //////// response property for the response status

  • c2ab03503a27Revision changes
    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ///////// response property oneOf list for the response status

    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ///////// response property oneOf list for the response status

    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ////// response property oneOf list for the response status

    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the //////// response property oneOf list for the response status

    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ////// response property oneOf list for the response status