Egnyte MSP Public API (1.0.0)
Download OpenAPI specification:Download
Egnyte MSP Public API - Allows MSPs to access information present on the Reseller Portal
This is a set of endpoints to manage webhooks. The number of webhooks registered for one pair: clientId+NFRDomain is limited.
Get list of webhooks
Returns a list of webhooks registered by the MSP.
Authorizations:
CodeGrantAuth
Responses
Response Schema: application/json
Array
| webhook_id | string (WebhookId) |
| status | string Enum: "enabled" "disabled" |
Response samples
- 200
- 401
Content type
application/json
[- {
- "status": "enabled",
- "webhook_id": "4091c6d2-1bce-4df8-a119-a7bcb9b8474c"
}, - {
- "status": "enabled",
- "webhook_id": "656bc761-9454-464c-adff-457691b5effa"
}, - {
- "status": "enabled",
- "webhook_id": "e4bf314d-4657-483a-a2b2-db1eda8c9509"
}
]Register a webhook
Endpoint for registering a webhook to a URL. Endpoint returns ID of newly registered webhook and current status. For webhook payloads documentation see specification of the receiver endpoint: Webhook Receiver documentation
Authorizations:
CodeGrantAuth
Request Body schema: application/json
| webhook_url required | string |
| eventTypes required | Array of strings (EventType) non-empty Items Enum: "RESELLER_LINK_NFR_MANUALLY" "RESELLER_CREATED_CONNECT_TRIAL" "RESELLER_CREATED_PROTECT_TRIAL" "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID" "RESELLER_CONVERTED_PROTECT_TRIAL_TO_PAID" "RESELLER_CONNECT_TRIAL_EXPIRED" "RESELLER_PROFILE_UPDATED" "RESELLER_MRR_CHANGED" "RESELLER_FIRST_LOGIN" "RESELLER_CC_ADDED" "RESELLER_PVI_ADDED" "USER_ADDED" "RESELLER_TFA_ENABLED" "RESELLER_TFA_ENROLLED" "USER_TFA_ENABLED" "USER_TFA_ENROLLED" "RESELLER_UPSELL_INVOICE_GENERATED" "RESELLER_RECURRING_INVOICE_GENERATED" "RESELLER_INVOICE_EDITED" "RESELLER_INVOICE_PAID" |
| auth_header required | string |
| auth_header_value required | string |
Responses
Response Schema: application/json
| webhook_id | string (WebhookId) |
| status | string Enum: "enabled" "disabled" |
Request samples
- Payload
Content type
application/json
{- "event_types": [
- "RESELLER_LINK_NFR_MANUALLY",
- "RESELLER_CREATED_CONNECT_TRIAL",
- "RESELLER_CREATED_PROTECT_TRIAL",
- "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID"
], - "auth_header": "AUTH-TOKEN",
- "auth_header_value": "XYZ"
}Response samples
- 200
- 400
- 401
- 409
Content type
application/json
{- "status": "enabled",
- "webhook_id": "a63790bf-2847-4abd-a0cb-3a06c3958659"
}Get webhook details
Returns details of the webhook
Authorizations:
CodeGrantAuth
path Parameters
| webhook_id required | string |
Responses
Response Schema: application/json
| webhook_id | string (WebhookId) |
| webhook_url | string |
| event_types | Array of strings (EventType) non-empty Items Enum: "RESELLER_LINK_NFR_MANUALLY" "RESELLER_CREATED_CONNECT_TRIAL" "RESELLER_CREATED_PROTECT_TRIAL" "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID" "RESELLER_CONVERTED_PROTECT_TRIAL_TO_PAID" "RESELLER_CONNECT_TRIAL_EXPIRED" "RESELLER_PROFILE_UPDATED" "RESELLER_MRR_CHANGED" "RESELLER_FIRST_LOGIN" "RESELLER_CC_ADDED" "RESELLER_PVI_ADDED" "USER_ADDED" "RESELLER_TFA_ENABLED" "RESELLER_TFA_ENROLLED" "USER_TFA_ENABLED" "USER_TFA_ENROLLED" "RESELLER_UPSELL_INVOICE_GENERATED" "RESELLER_RECURRING_INVOICE_GENERATED" "RESELLER_INVOICE_EDITED" "RESELLER_INVOICE_PAID" |
| auth_header | string |
| auth_header_value | string |
| status | string Enum: "enabled" "disabled" |
Response samples
- 200
- 401
- 404
Content type
application/json
{- "webhook_id": "e4bf314d-4657-483a-a2b2-db1eda8c9509",
- "event_types": [
- "RESELLER_LINK_NFR_MANUALLY",
- "RESELLER_CREATED_CONNECT_TRIAL",
- "RESELLER_CREATED_PROTECT_TRIAL",
- "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID"
], - "auth_header": "X-TOKEN",
- "auth_header_value": "a234fsd34fsdf4eghujj68",
- "status": "enabled"
}Update a webhook
Endpoint for updating a webhook
Authorizations:
CodeGrantAuth
path Parameters
| webhook_id required | string |
Request Body schema: application/json
| webhook_url required | string |
| eventTypes required | Array of strings (EventType) non-empty Items Enum: "RESELLER_LINK_NFR_MANUALLY" "RESELLER_CREATED_CONNECT_TRIAL" "RESELLER_CREATED_PROTECT_TRIAL" "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID" "RESELLER_CONVERTED_PROTECT_TRIAL_TO_PAID" "RESELLER_CONNECT_TRIAL_EXPIRED" "RESELLER_PROFILE_UPDATED" "RESELLER_MRR_CHANGED" "RESELLER_FIRST_LOGIN" "RESELLER_CC_ADDED" "RESELLER_PVI_ADDED" "USER_ADDED" "RESELLER_TFA_ENABLED" "RESELLER_TFA_ENROLLED" "USER_TFA_ENABLED" "USER_TFA_ENROLLED" "RESELLER_UPSELL_INVOICE_GENERATED" "RESELLER_RECURRING_INVOICE_GENERATED" "RESELLER_INVOICE_EDITED" "RESELLER_INVOICE_PAID" |
| auth_header required | string |
| auth_header_value required | string |
Responses
Response Schema: application/json
| webhook_id | string (WebhookId) |
| status | string Enum: "enabled" "disabled" |
Request samples
- Payload
Content type
application/json
{- "event_types": [
- "RESELLER_LINK_NFR_MANUALLY",
- "RESELLER_CREATED_CONNECT_TRIAL",
- "RESELLER_CREATED_PROTECT_TRIAL",
- "RESELLER_CONVERTED_CONNECT_TRIAL_TO_PAID"
], - "auth_header": "AUTH-TOKEN",
- "auth_header_value": "XYZ"
}Response samples
- 200
- 400
- 401
Content type
application/json
{- "status": "enabled",
- "webhook_id": "e4bf314d-4657-483a-a2b2-db1eda8c9509"
}Get list of domains
Returns a paginated list of domains registered by MSP.
Authorizations:
CodeGrantAuth
query Parameters
| planName | string Parameter to filter domains by planName field |
Responses
Response Schema: application/json
| count | integer Total number of domains returned in response |
| next | string Address of next results, max 10 elements (domains) per page |
| previous | string Address of previous results, max 10 elements (domains) per page |
Array of objects (Domain) |
Response samples
- 200
- 401
Content type
application/json
[- {
- "next": null,
- "previous": null,
- "count": 10,
- "results": [
- {
- "domain": "testDomain",
- "planId": 1,
- "planName": "Platform Enterprise",
- "status": "active",
- "createdOn": "2024-03-28T00:00:00",
- "subscriptionDate": "2024-03-23",
- "availablePuLicences": 10,
- "usedPuLicences": 1,
- "unusedPuLicences": 9,
- "availableSuLicences": 10,
- "usedSuLicences": 0,
- "unusedSuLicences": 10,
- "availableStorage": 2000,
- "usedStorage": 0,
- "allocatedStorage": 1000
}
]
}
]Get domain details
Returns details of the domain
Authorizations:
CodeGrantAuth
path Parameters
| domain | string Parameter to fetch domain by domain field |
Responses
Response Schema: application/json
| domain | string Child domain name |
| planId | integer Plan identifier |
| planName | string Plan name |
| status | string (DomainStatus) Enum: "active" "on hold" "cancelled" "locked" "reseller manual locked" "trial" "cc declined" Response returns domains in trial and active, does not include deleted |
| createdOn | string <date-time> Date when the trial was created |
| subscriptionDate | string <date> Date of activating the trial, null for trial domains |
| availablePuLicences | integer or null Overall quota of Power Users in plan. |
| usedPuLicences | integer or null Power Users Used Licenses for the domain. |
| unusedPuLicences | integer or null Power Users Unused Licenses for domain. |
| availableSuLicences | integer or null Overall quota of Standard Users available in plan. |
| usedSuLicences | integer or null Standard User Used Licenses for domain. |
| unusedSuLicences | integer or null Standard User Unused Licenses for domain. |
| availableStorage | integer Overall quota of storage available in plan, in [GB] |
| usedStorage | integer How much storage the domain uses, in [GB] |
| allocatedStorage | integer How much storage is allocated to the domain, sum of used and unused, in [GB] |
Array of objects (ServiceDetails) | |
Array of objects (ServiceDetails) |
Response samples
- 200
- 401
- 404
Content type
application/json
{- "domain": "testDomain",
- "planId": 1,
- "planName": "Platform Enterprise",
- "status": "active",
- "createdOn": "2024-03-19T00:00:00",
- "subscriptionDate": "2024-03-19",
- "availablePuLicences": 3,
- "usedPuLicences": 1,
- "unusedPuLicences": 2,
- "availableSuLicences": 3,
- "usedSuLicences": 1,
- "unusedSuLicences": 2,
- "availableStorage": 1000,
- "usedStorage": 0,
- "allocatedStorage": 10,
- "monthlyCost": 0,
- "features": [
- {
- "name": "olc",
- "title": "Turbo or Storage Sync",
- "category": "2 Free, Extra Optional",
- "type": "flat",
- "numPurchased": 2
}, - {
- "name": "sf_integration_2",
- "title": "Salesforce Integration 2.0",
- "category": "Optional",
- "type": "flat",
- "numPurchased": 0
}, - {
- "name": "apc_standard",
- "title": "Advanced Privacy and Compliance - Standard",
- "category": "Optional",
- "type": "flat",
- "numPurchased": 0
}, - {
- "name": "apc_premium",
- "title": "Advanced Privacy and Compliance - Premium",
- "category": "Optional",
- "type": "flat",
- "numPurchased": 0
}, - {
- "name": "apc_premium_additional_connectors",
- "title": "APC - Premium - Additional Connectors",
- "category": "Optional",
- "type": "flat",
- "numPurchased": 0
}
], - "sources": [
- {
- "name": "data_security_mgmt_gmail_users",
- "title": "Gmail Users",
- "category": "Optional",
- "type": "flat",
- "numPurchased": 0
}
]
}Get list of tenants
Returns a paginated list of protect tenants registered by MSP.
Authorizations:
CodeGrantAuth
query Parameters
| planName | string Parameter to filter tenants by planName field |
Responses
Response Schema: application/json
| count | integer Total number of tenants returned in response |
| next | string Address of next results, max 10 elements (tenants) per page |
| previous | string Address of previous results, max 10 elements (tenants) per page |
Array of objects (Tenant) |
Response samples
- 200
- 401
Content type
application/json
[- {
- "next": null,
- "previous": null,
- "count": 3,
- "results": [
- {
- "tenant": "protecttestdomain1",
- "domain": "testdomain1",
- "planId": 20202,
- "planName": "Protect",
- "createdOn": "2024-05-08T00:00:00",
- "subscriptionDate": null,
- "status": "trial",
- "cupUsed": 69,
- "cupIncluded": 500,
- "totalCupPurchased": 10005,
- "totalCupIncluded": 1000,
- "totalCupAvailable": 11005,
- "totalCupUsed": 8669,
- "totalCupUnused": 2336
}, - {
- "tenant": "protecttestdomain2",
- "domain": "testdomain2",
- "planId": 20202,
- "planName": "Protect",
- "createdOn": "2024-04-19T00:00:00",
- "subscriptionDate": "2024-05-08",
- "status": "active",
- "cupUsed": 20,
- "cupIncluded": 500,
- "totalCupPurchased": 10005,
- "totalCupIncluded": 1000,
- "totalCupAvailable": 11005,
- "totalCupUsed": 8669,
- "totalCupUnused": 2336
}, - {
- "tenant": "protecttestdomain3",
- "domain": "testdomain3",
- "planId": 20202,
- "planName": "Protect",
- "createdOn": "2024-04-19T00:00:00",
- "subscriptionDate": "2024-04-24",
- "status": "active",
- "cupUsed": 8649,
- "cupIncluded": 500,
- "totalCupPurchased": 10005,
- "totalCupIncluded": 1000,
- "totalCupAvailable": 11005,
- "totalCupUsed": 8669,
- "totalCupUnused": 2336
}
]
}
]Get tenant details
Returns details of the tenant
Authorizations:
CodeGrantAuth
path Parameters
| tenant | string |
Responses
Response Schema: application/json
| tenant | string Tenant name |
| domain | string Domain name associated with the tenant |
| planId | integer Plan identifier |
| planName | string Name of the plan |
| createdOn | string <date-time> Date when the trial was created |
| subscriptionDate | string <date> Date of activating the trial |
| status | string (TenantStatus) Enum: "active" "on hold" "cancelled" "locked" "reseller manual locked" "trial" "trial expired" "cc declined" |
| cupUsed | integer or null Content Under Protection used by tenant |
| cupIncluded | integer or null Included Content Under Protection available to tenant |
| totalCupPurchased | integer or null Total Purchased Content Under Protection available to MSP |
| totalCupIncluded | integer or null Total Included Content Under Protection available to MSP |
| totalCupAvailable | integer or null Total Content Under Protection available to MSP |
| totalCupUsed | integer or null Total Content Under Protection used by all tenants of the MSP |
| totalCupUnused | integer or null Total Unused Content Under Protection available to MSP |
| monthlyCost | number or null <double> Monthly base cost of the Protect plan |
Response samples
- 200
- 401
- 404
Content type
application/json
{- "tenant": "protecttestdomain3",
- "domain": "testdomain3",
- "planId": 20202,
- "planName": "Protect",
- "createdOn": "2024-04-19T00:00:00",
- "subscriptionDate": "2024-04-24",
- "status": "active",
- "cupUsed": 8649,
- "cupIncluded": 500,
- "totalCupPurchased": 10005,
- "totalCupIncluded": 1000,
- "totalCupAvailable": 11005,
- "totalCupUsed": 8669,
- "totalCupUnused": 2336,
- "monthlyCost": 400.99
}Get list of available plans
Returns a paginated list of plans available for MSP.
Authorizations:
CodeGrantAuth
Responses
Response Schema: application/json
| count | integer Total number of domains returned in response |
| next | string Address of next results, max 10 elements (domains) per page |
| previous | string Address of previous results, max 10 elements (domains) per page |
Array of Plan (object) or ProtectPlan (object) or DlcPlan (object) |
Response samples
- 200
- 401
Content type
application/json
[- {
- "next": null,
- "previous": null,
- "count": 10,
- "results": [
- {
- "planId": 10,
- "planName": "Example Plan",
- "maxPlanPuLicences": 5,
- "maxPlanSuLicences": 10,
- "costPerUser": 10,
- "maxPlanStorage": 10,
- "features": [
- {
- "name": "example name",
- "type": "example type"
}
], - "packages": [
- {
- "name": "example name",
- "type": "example type"
}
], - "sources": [
- {
- "name": "example name",
- "type": "example type"
}
]
}, - {
- "planId": 10,
- "planName": "Example Plan",
- "maxPlanPuLicences": 5,
- "maxPlanSuLicences": 10,
- "maxPlanStorage": 10,
- "allocatedPlanStorage": 1,
- "availablePlanStorage": 9,
- "features": [
- {
- "name": "example name",
- "type": "example type"
}
], - "packages": [
- {
- "name": "example name",
- "type": "example type"
}
], - "sources": [
- {
- "name": "example name",
- "type": "example type"
}
]
}, - {
- "planId": 10,
- "planName": "Protect Plan",
- "totalCupPurchased": 0,
- "totalCupIncluded": 0,
- "totalCupAvailable": 0,
- "totalCupUsed": 0,
- "totalCupUnused": 0
}
]
}
]