SharePoint Monitoring

API endpoints to manage and view information for SharePoint monitoring

/api/storage-monitor/sharepoint/v1/sites

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites

List SharePoint sites

Lists SharePoint sites

/api/storage-monitor/sharepoint/v1/sites › query Parameters

skipToken

string

Skip token to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites › Responses

Success

ListSitesResponse

object[]

skipToken

string

Skip token used to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives

List SharePoint drives

Lists SharePoint drives

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › path Parameters

siteId

string · required

Identifier for the site

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › query Parameters

skipToken

string

Skip token to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › Responses

Success

ListDrivesResponse[]

ListDrivesResponse

object[]

skipToken

string

Skip token used to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

POST

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Create a new SharePoint storage monitor

Creates a new SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Request Body optional

policyName

string

The name of the content management policy to apply when rebuilding files from the monitored drive. By default, the "default" content management policy is used.

Default: default

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint monitor created

CreateMonitorResponse

id

string · uuid

Unique Identifier for the created monitor

Example: 11111111-1111-1111-1111-111111111111

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

DELETE

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Delete the active SharePoint storage monitor

Deletes the active SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint storage monitor deleted

No data returned

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

PATCH

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Update an existing SharePoint storage monitor

Updates an existing SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Request Body optional

policyName

string

The name of the content management policy to apply when rebuilding files from the monitored drive.

Example: default

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint monitor updated

CreateMonitorResponse

id

string · uuid

Unique Identifier for the created monitor

Example: 11111111-1111-1111-1111-111111111111

/api/storage-monitor/sharepoint/v1/monitors

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

List active SharePoint storage monitors

Lists the active SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › query Parameters

pageSize

string

Amount of SharePoint monitors to return

Default: 10

pageIndex

string

Page number to start returning data from

Default: 1

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of all active SharePoint storage monitors

ListSharePointMonitorItem

object[]

object

/api/storage-monitor/sharepoint/v1/monitors

POST

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Create SharePoint storage monitors

Create the selected SharePoint storage monitors with the specified policy

/api/storage-monitor/sharepoint/v1/monitors › Request Body

SharePointCreateMonitorsRequest

rootId

string

The Id of the SharePoint Site to create monitors for.

ids

string[]

selectAll

boolean

Whether to select all Document Libraries for the specified SharePoint Site or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

policyName

string

Policy to apply for the created monitors

Example: default

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of any issues which occured during creation

BulkResponse

object[]

/api/storage-monitor/sharepoint/v1/monitors

DELETE

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Delete SharePoint storage monitors

Deletes the selected SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › Request Body

DeleteMonitorsRequest

ids

string[]

selectAll

boolean

Whether to select all active storage monitors or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of any issues which occured during deletion

BulkResponse

object[]

/api/storage-monitor/sharepoint/v1/monitors

PATCH

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Update existing SharePoint storage monitors

Update existing SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › Request Body

PatchMonitorsRequest

ids

string[]

selectAll

boolean

Whether to select all active storage monitors or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

object

/api/storage-monitor/sharepoint/v1/monitors › Responses

SharePoint monitor updated

BulkResponse

object[]

PATCH/api/storage-monitor/sharepoint/v1/monitors

curl https://api.glasswall.com/api/storage-monitor/sharepoint/v1/monitors \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <credentials>' \
  --data '{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "selectAll": false,
  "patches": {
    "status": "started",
    "policyName": "default"
  }
}'

Example Request Body

{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "selectAll": false,
  "patches": {
    "status": "started",
    "policyName": "default"
  }
}

json

Example Responses

{
  "issues": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "error": "monitor does not exist",
      "resourceName": "test resource"
    }
  ]
}

json

application/json

/api/storage-monitor/sharepoint/v1/status

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/status

Get the status of the SharePoint Storage Monitoring service

Gets the status of the SharePoint Storage Monitoring service

/api/storage-monitor/sharepoint/v1/status › Responses

200

The current status of the SharePoint Storage Monitoring service

GetStorageMonitorStatusResponse

isHealthy

boolean

Specifies whether the Storage Monitor is healthy

Example: false

object[]

Health check results including service checks such as Webhook, Permissions, ProviderApi and License.

Example: [{"check":"License","isSuccess":false,"reason":"License is missing following entitlements required for operation: Glasswall Halo: Storage Monitoring"},{"check":"Permissions","isSuccess":true,"reason":null}]

OneDrive Monitoring

Storage Monitoring Api

SharePoint Monitoring

API endpoints to manage and view information for SharePoint monitoring

/api/storage-monitor/sharepoint/v1/sites

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites

List SharePoint sites

Lists SharePoint sites

/api/storage-monitor/sharepoint/v1/sites › query Parameters

skipToken

string

Skip token to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites › Responses

Success

ListSitesResponse

object[]

skipToken

string

Skip token used to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives

List SharePoint drives

Lists SharePoint drives

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › path Parameters

siteId

string · required

Identifier for the site

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › query Parameters

skipToken

string

Skip token to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives › Responses

Success

ListDrivesResponse[]

ListDrivesResponse

object[]

skipToken

string

Skip token used to fetch next page of data

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

POST

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Create a new SharePoint storage monitor

Creates a new SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Request Body optional

policyName

string

The name of the content management policy to apply when rebuilding files from the monitored drive. By default, the "default" content management policy is used.

Default: default

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint monitor created

CreateMonitorResponse

id

string · uuid

Unique Identifier for the created monitor

Example: 11111111-1111-1111-1111-111111111111

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

DELETE

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Delete the active SharePoint storage monitor

Deletes the active SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint storage monitor deleted

No data returned

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

PATCH

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors

Update an existing SharePoint storage monitor

Updates an existing SharePoint storage monitor

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › path Parameters

siteId

string · required

Identifier for the site

driveId

string · required

Identifier for the drive

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Request Body optional

policyName

string

The name of the content management policy to apply when rebuilding files from the monitored drive.

Example: default

/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors › Responses

SharePoint monitor updated

CreateMonitorResponse

id

string · uuid

Unique Identifier for the created monitor

Example: 11111111-1111-1111-1111-111111111111

/api/storage-monitor/sharepoint/v1/monitors

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

List active SharePoint storage monitors

Lists the active SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › query Parameters

pageSize

string

Amount of SharePoint monitors to return

Default: 10

pageIndex

string

Page number to start returning data from

Default: 1

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of all active SharePoint storage monitors

ListSharePointMonitorItem

object[]

object

/api/storage-monitor/sharepoint/v1/monitors

POST

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Create SharePoint storage monitors

Create the selected SharePoint storage monitors with the specified policy

/api/storage-monitor/sharepoint/v1/monitors › Request Body

SharePointCreateMonitorsRequest

rootId

string

The Id of the SharePoint Site to create monitors for.

ids

string[]

selectAll

boolean

Whether to select all Document Libraries for the specified SharePoint Site or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

policyName

string

Policy to apply for the created monitors

Example: default

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of any issues which occured during creation

BulkResponse

object[]

/api/storage-monitor/sharepoint/v1/monitors

DELETE

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Delete SharePoint storage monitors

Deletes the selected SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › Request Body

DeleteMonitorsRequest

ids

string[]

selectAll

boolean

Whether to select all active storage monitors or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

/api/storage-monitor/sharepoint/v1/monitors › Responses

A list of any issues which occured during deletion

BulkResponse

object[]

/api/storage-monitor/sharepoint/v1/monitors

PATCH

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/monitors

Update existing SharePoint storage monitors

Update existing SharePoint storage monitors

/api/storage-monitor/sharepoint/v1/monitors › Request Body

PatchMonitorsRequest

ids

string[]

selectAll

boolean

Whether to select all active storage monitors or not. If true the ids argument can be used as an exclusion list, if false the ids argument will be an inclusion list.

Default: false

object

/api/storage-monitor/sharepoint/v1/monitors › Responses

SharePoint monitor updated

BulkResponse

object[]

PATCH/api/storage-monitor/sharepoint/v1/monitors

curl https://api.glasswall.com/api/storage-monitor/sharepoint/v1/monitors \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <credentials>' \
  --data '{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "selectAll": false,
  "patches": {
    "status": "started",
    "policyName": "default"
  }
}'

Example Request Body

{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "selectAll": false,
  "patches": {
    "status": "started",
    "policyName": "default"
  }
}

json

Example Responses

{
  "issues": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "error": "monitor does not exist",
      "resourceName": "test resource"
    }
  ]
}

json

application/json

/api/storage-monitor/sharepoint/v1/status

GET

https://api.glasswall.com

/api/storage-monitor/sharepoint/v1/status

Get the status of the SharePoint Storage Monitoring service

Gets the status of the SharePoint Storage Monitoring service

/api/storage-monitor/sharepoint/v1/status › Responses

200

The current status of the SharePoint Storage Monitoring service

GetStorageMonitorStatusResponse

isHealthy

boolean

Specifies whether the Storage Monitor is healthy

Example: false

object[]

Health check results including service checks such as Webhook, Permissions, ProviderApi and License.

OneDrive Monitoring