ScanopyScanopy
Shares

List all shares

GET
/api/v1/shares
Authorization<token>

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

In: header

Query Parameters

network_id?string|null

Filter by network ID

Formatuuid
topology_id?string|null

Filter by topology ID

Formatuuid
limit?integer|null

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

Formatint32
Range0 <= value <= 1000
offset?integer|null

Number of results to skip. Default: 0.

Formatint32
Range0 <= value

Response Body

application/json

curl -X GET "https://loading/api/v1/shares"
{
  "data": [
    {
      "allowed_domains": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "expires_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "is_enabled": true,
      "name": "string",
      "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
      "options": {
        "show_export_button": true,
        "show_inspect_panel": true,
        "show_zoom_controls": true
      },
      "topology_id": "a1fb5dbc-e877-4a57-93d2-9d6f34add5bf",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.13.5"
  },
  "success": true,
  "error": "string"
}