SCscanopy
Interfaces

List interfaces

Changed on
get/api/v1/interfaces

Request

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

Query parameters

host_idstring uuid nullable

Filter by host ID

site_idstring uuid nullable

Filter by site ID

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

atstring date-time nullable

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

Response

List of Interfaces

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

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,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "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