Skip to main content
Ctrl+K
cloudplan API v2 documentation - Home cloudplan API v2 documentation - Home
  • Getting Started
  • API Reference
  • Concepts
  • Portal
  • Old Docs Page
  • Getting Started
  • API Reference
  • Concepts
  • Portal
  • Old Docs Page

Section Navigation

Storage v1 API

  • List all Root Directories
  • List Folder Content
  • Create a new Folder
  • Delete Folders and Files
  • Upload a File

Datatable API

  • Get Rows
  • Add Rows

Weblink API

  • Create a Weblink
  • List Weblinks
  • Revoke a Weblink
  • API Reference
  • List Weblinks

List Weblinks#

Provides a list of all weblinks for a given folder.

Endpoint#
 POST https://api.cloudplan.net/api/weblink/get

Request Parameters#

Possible request parameters#
{
    "folder_id": ""
}

folder_id | (string)

Id of the folder used.

Reply Parameters#

JSON Reply#
{
    "weblinks": []
}

weblinks | (list of objects)

A list of all weblink objects for this folder or files directly inside the folder. See Weblink Objects.

Example#

This lists weblinks for the given folder.

Example Request#
{
    "folder_id": "6319C982C7C0D952BFAA7347D212E57D"
}
Exmple Reply#
{
    "weblinks": [
        {
            "weblink_id": "6960FA8432CE1222719822E551EC43A8",
            "folder_id": "6319C982C7C0D952BFAA7347D212E57D",
            "file_id": "6729D89570415228835B3A96AE798D4B",
            "approved": true,
            "needs_approval": false,
            "views": 0,
            "max_downloads": 0,
            "downloads": 0,
            "valid_until": 1772801668,
            "created": 1767963268,
            "creator_id": "56A23EB6998F303B134C1C0A723447B0",
            "permissions": "write",
            "protected": false
        }
    ]
}
On this page
  • Request Parameters
  • Reply Parameters
  • Example

© Copyright 2026, cloudplan GmbH.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.