Sign in

v4

Swagger 2.02026-08-0343714211.7 MB
child_site_management_policies
Child Site Management Policies

List Child Site Management Policies

List Child Site Management Policies

get/child_site_management_policies

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of ChildSiteManagementPolicies objects.

idinteger

Policy ID.

policy_type'settings'

Type of policy. Valid values: settings.

namestring

Name for this policy.

descriptionstring

Description for this policy.

valueobject

Policy configuration data. Settings policies accept site settings plus an optional folder_behaviors array for parent-managed root behaviors on child sites. For more information, refer to the Value Hash section of the developer documentation.

applied_child_site_idsinteger[]

IDs of child sites that this policy has been applied to. This field is read-only.

skip_child_site_idsinteger[]

IDs of child sites excluded from this default policy.

child_site_idsinteger[]

IDs of child sites explicitly assigned to this non-default policy.

default_policyboolean

Whether this policy applies to child sites not explicitly assigned to another policy.

created_atstring date-time

When this policy was created.

updated_atstring date-time

When this policy was last updated.

Example response

[
  {
    "id": 1,
    "policy_type": "settings",
    "name": "example",
    "description": "example",
    "applied_child_site_ids": [
      1,
      2
    ],
    "skip_child_site_ids": [
      1,
      2
    ],
    "child_site_ids": [
      1,
      2
    ],
    "default_policy": true,
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]