ScanopyScanopy
VLANs

Create VLAN

Creates a VLAN scoped to a site. VLAN numbers must be unique within a site.

POST
/api/v1/vlans

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/vlans" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",    "tags": [      "a424dc99-d215-4281-ad2d-a3a9bc179925"    ],    "vlan_number": 0  }'
{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.6"
  },
  "success": true,
  "data": {
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    "tags": [
      "a424dc99-d215-4281-ad2d-a3a9bc179925"
    ],
    "vlan_number": 0,
    "description": "string",
    "interface_ids": [
      "513ddd9b-363c-404c-8d2f-e4772a6284ee"
    ],
    "name_source": "Unspecified",
    "source": {
      "type": "Manual"
    },
    "subnet_ids": [
      "942824b1-f36d-4404-96ac-b099828cf934"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z",
    "first_discovery_id": "6902465b-102c-46e4-8f8c-33ac44cf66e9",
    "last_discovery_id": "48da132e-8b2a-4a5e-9c95-ecca249347f8",
    "last_seen_at": "2019-08-24T14:15:22Z",
    "lineage_id": "29b62bee-90fd-477a-963b-7a89d5ffca9a",
    "valid_from": "2019-08-24T14:15:22Z",
    "valid_to": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.6"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.6"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

Product names and logos are trademarks of their respective owners. See credits.