disk-file-get-external-link.md

Get Public Link for File disk.file.getExternalLink

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: disk

Who can execute the method: user with "Read" permission for the required file

The method disk.file.getExternalLink returns a public link to a file.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | Identifier of the file.

The identifier can be obtained using the method disk.storage.getChildren if the file is in the root of the storage, and using the method disk.folder.getChildren if the file is in a folder || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":8964}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.getExternalLink

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":8964,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/disk.file.getExternalLink

• JS (TS)

  // This snippet is an ES module: top-level await requires type="module" or a bundler.
  // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
  import { Text } from '@bitrix24/b24jssdk'
  import type { B24Frame } from '@bitrix24/b24jssdk'
  
  declare const $b24: B24Frame
  
  try {
    const response = await $b24.actions.v2.call.make<string>({
      method: 'disk.file.getExternalLink',
      params: {
        id: 8964,
      },
      requestId: Text.getUuidRfc4122()
    })
  
    // The payload is available only on a successful response
    if (!response.isSuccess) {
      console.error(response.getErrorMessages().join('; '))
    } else {
      const result = response.getData()!.result
      console.info('External link:', result)
    }
  } catch (error) {
    // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
    console.error(error)
  }

• JS (UMD)

  <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
  <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
  <script>
    async function getExternalLink() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'disk.file.getExternalLink',
          params: {
            id: 8964,
          },
          requestId: B24Js.Text.getUuidRfc4122()
        })
  
        // The payload is available only on a successful response
        if (!response.isSuccess) {
          console.error(response.getErrorMessages().join('; '))
          return
        }
  
        const result = response.getData().result
        console.info('External link:', result)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', getExternalLink)
  </script>

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'disk.file.getExternalLink',
              [
                  'id' => 8964
              ]
          );
  
      $result = $response
          ->getResponseData()
          ->getResult();
  
      echo 'Success: ' . print_r($result, true);
      processData($result);
  
  } catch (Throwable $e) {
      error_log($e->getMessage());
      echo 'Error getting external link: ' . $e->getMessage();
  }

• BX24.js

  BX24.callMethod(
      "disk.file.getExternalLink",
      {
          id: 8964
      },
      function (result)
      {
          if (result.error())
              console.error(result.error());
          else
              console.dir(result.data());
      }
  );

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'disk.file.getExternalLink',
      [
          'id' => 8964
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "disk.file.getExternalLink", b24.Params{
  	"id": 8964,
  })
  if err != nil {
  	return fmt.Errorf("disk.file.getExternalLink: %w", err)
  }
  
  var value string
  if err := json.Unmarshal(res.Result, &value); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  fmt.Println("result:", value)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": "https://test.bitrix24.com/~4Pie9",
    "time": {
        "start": 1770651076,
        "finish": 1770651076.172321,
        "duration": 0.17232108116149902,
        "processing": 0,
        "date_start": "2026-02-09T15:31:16+01:00",
        "date_finish": "2026-02-09T15:31:16+01:00",
        "operating_reset_at": 1770651676,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result string | Public link to the file || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

{
    "error":"ERROR_ARGUMENT",
    "error_description":"Invalid value of parameter {Parameter #0}"
}

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || ERROR_ARGUMENT | Invalid value of parameter {Parameter #0} | Required parameter id is missing || || ERROR_NOT_FOUND | Could not find entity with id X | File with the specified id not found || || ACCESS_DENIED | Access denied | Insufficient permissions to obtain the file link || |#

{% include system errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}