Get share resource by ID

client.resourceSharing.resources.get(, , , ?): ResourceGetResponse { id, created, meta, 6 more }

GET/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Get share resource by ID.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

shareId: string

Share identifier tag.

maxLength32

resourceId: string

Share Resource identifier.

maxLength32

params: ResourceGetParams { account_id }

account_id: string

Account identifier.

maxLength32

ReturnsExpand Collapse

ResourceGetResponse { id, created, meta, 6 more }

id: string

Share Resource identifier.

maxLength32

created: string

When the share was created.

formatdate-time

meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time

resource_account_id: string

Account identifier.

maxLength32

resource_id: string

Share Resource identifier.

maxLength32

resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 2 more

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

Get share resource by ID

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const resource = await client.resourceSharing.resources.get(
  '3fd85f74b32742f1bff64a85009dda07',
  '023e105f4ecef8ad9ca31a8372d0c353',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(resource.id);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created": "2023-09-21T18:56:32.624632Z",
    "meta": {},
    "modified": "2023-09-21T18:56:32.624632Z",
    "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_type": "custom-ruleset",
    "resource_version": 0,
    "status": "active"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "created": "2023-09-21T18:56:32.624632Z",
    "meta": {},
    "modified": "2023-09-21T18:56:32.624632Z",
    "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "resource_type": "custom-ruleset",
    "resource_version": 0,
    "status": "active"
  }
}