Resource index and summary

Agents and Gateways


Resource	Description	POST	GET	DELETE
apiTokenGen	Generates an access token on the gateway.	◯
applicationservice	Gets the service status and starts and stops application services.	◯
download/gateway/{packagename}	Downloads gateway files from the download server.		◯
externalproxy	Configures the external proxy connection on the gateway.	◯
generalinfo	Gets general information from the gateway, including appliance details and network information.		◯
getntpdetails	Gets NTP details from the gateway.		◯
gettimezoneinfo	Gets timezone information from the gateway.		◯
networksettings	Specifies the network settings on the gateway.	◯
nginx	Gets the NGINX service status and restarts the NGINX service on the gateway.	◯
ntpmanualconfig	Manually sets the NTP date and time on the gateway.	◯
ntpservice	Starts and stops the gateway NTP service.	◯
ntpsyncips	Synchronizes gateway NTP servers time.	◯
ntpupdateips	Updates gateway NTP server IP addresses.	◯
proxy	Turn the gateway Squid proxy server on and off.	◯
registration	Registers the gateway.	◯
restartnetwork	Restarts the gateway network service.	◯
settimezone	Sets the gateway timezone.	◯
staticroute	Sets the gateway static route configuration.	◯
tenants/{tenantId}/agentPolicies/{policyId}/devices	Assigns agent resource policies.	◯
tenants/{tenantId}/agentProfiles/{profileId}/devices	Assigns agent resource profiles.	◯
tenants/{tenantId}/agents/{agentversion}/resourcesCountByAgentVersion	Gets the number of installed agent resources by agent version.		◯
tenants/{tenantId}/agents/deployAgentsScript	Downloads the Linux agent installation script.		◯
tenants/{tenantId}/agents/{platform}/download/{package-name}	Downloads the Linux agents.		◯
tenants/{tenantId}/agents/{platform}/info	Gets the Linux agent. This is usually followed by an API call to Download Linux Agent.		◯
tenants/{tenantId}/agents/windows	Downloads the Windows agent.		◯
tenants/{tenantId}/managementProfiles	Creates a management profile.	◯
tenants/{tenantId}/managementProfiles/{id}/attach	Attaches a gateway to a management profile and generates an activation token. The generated activation token is used in gateway registration.		◯
tenants/{tenantId}/managementProfiles/{profileId}	Gets, updates, and deletes a management profile.	◯	◯	◯
tenants/{tenantId}/managementProfiles/{profileId}/detach	Unmaps, or detaches, the gateway from the management profile and invalidates the activation token.		◯
tenants/{tenantId}/managementProfiles/{profileId}/reconnectTunnel	Reconnects the management profile tunnel.		◯
tenants/{tenantId}/managementProfiles/search	Searches for a management profiles.		◯

Alerts


Resource	Description	POST	PUT	GET	DELETE
alerts/tenants/{tenantId}/alerts/{alertId}	Gets alert details by alert ID.			◯
alerts/tenants/{tenantId}/tickets/{ticketId}	Gets alert details by incident ID.			◯
alertTypes	Gets the list of supported alert types.			◯
tenants/{tenantId}/alert	Creates a single alert on a resource.	◯
tenants/{tenantId}/alerts/{alertId}/acknowledge	Acknowledges an alert.	◯
tenants/{tenantId}/alerts/{alertId}/actions/{action}	Posts an action on an alert.	◯
tenants/{tenantId}/alerts/{alertId}	Gets alert details.			◯
tenants/{tenantId}/alerts/{alertId}/comments	Gets alert comments.			◯
tenants/{tenantId}/alerts/{alertId}/escalations	Gets the escalation policy attached to an alert.			◯
tenants/{tenantId}/alerts/{alertId}/incidents/{incidentId}/attach	Attaches an incident to an alert.	◯
tenants/{tenantId}/alerts/{alertId}/occurrences	Gets the alert occurrences based on the alert-triggered time.			◯
tenants/{tenantId}/alerts/{alertId}/tickets/{ticketId}/update	Updates an incident with an alert ID		◯
tenants/{tenantId}/alerts	Creates multiple alerts on resources.	◯
tenants/{tenantId}/alerts/event/{eventId}	Gets alert details by event ID.			◯
tenants/{tenantId}/alerts/search	Searches alerts.			◯
tenants/{tenantId}/alertStatusHistory/{alertId}	Gets alert status history.			◯
tenants/{tenantId}/escalations	Creates an alert escalation policy. The policy is a predefined action to be taken when an alert is not acknowledged.	◯
tenants/{tenantId}/escalations/{id}	Gets, update, and delete alert escalation policy information.	◯		◯	◯
tenants/{tenantId}/escalations/{id}/disable	Disables an alert escalation policy.	◯
tenants/{tenantId}/escalations/{id}/enable	Enables an alert escalation policy.	◯
tenants/{tenantId}/escalations/search	Gets the alert escalation policies attached to an alert.			◯
tenants/{tenantId}/policies/alertCorrelation	Creates and gets alert correlation policies.	◯		◯
tenants/{tenantId}/policies/alertCorrelation/{policyId}/{action}	Enables, disables, and creates an observed mode on an alert correlation policy.
tenants/{tenantId}/policies/alertCorrelation/{policyId}	Update, gets, and deletes an alert correlation policy by ID.	◯		◯	◯
tenants/{tenantId}/policies/firstResponse	Creates and views first response policydetails.	◯		◯
tenants/{tenantId}/policies/firstResponse/{policyId}	Updates, gets, and deletes a first response policy by ID.	◯		◯	◯
tenants/{tenantId}/policies/firstResponse/{policyId}/{status}	Enables and disables the first response policy.	◯
tenants/{tenantId}/rosters	Creates partner-level and client-level rosters.	◯
tenants/{tenantId}/rosters/{id}	Updates, gets, and deletes rosters.	◯		◯	◯
tenants/{tenantId}/rosters/search	Gets the rosters in an organization.			◯
tenants/{tenantId}/scheduleMaintenances	Creates a daily recurring schedule.	◯
tenants/{tenantId}/scheduleMaintenances/search	Gets the scheduled maintenance windows under a specific tenant.			◯
tenants/{tenantId}/scheduleMaintenances/{smId}	Updates, gets, and deletes scheduled maintenence windows.	◯		◯	◯
tenants/{tenantId}/scheduleMaintenances/{smId}/end	Ends a scheduled maintenance window.	◯
tenants/{tenantId}/scheduleMaintenances/{smId}/resources	Adds and deletes schedule maintenance window resources.	◯			◯
tenants/{tenantId}/scheduleMaintenances/{smId}/resources/{resourcesType}	Gets the list of devices (or device groups or sites) of a scheduled maintenance window.	◯
tenants/{tenantId}/scheduleMaintenances/{smId}/resume	Activates a user.	◯
tenants/{tenantId}/scheduleMaintenances/{smId}/suspend	Suspends a scheduled maintenance window.	◯
tenants/{tenantId}/subAlertTypes	Gets the sub-alert types.	◯
tenants/{tenantId}/users/{userId}/alertViews	Gets a list of alert views.			◯
tenants/{tenantId}/users/{userId}/alertViews/{viewId}	Gets an alert view of a user.			◯

Automation

# Automation


Resource	Description	POST	PUT	GET	DELETE
tenants/{tenantId}/jobs	Creates a job.	◯
tenants/{tenantId}/jobs/{id}	Gets, update, and delete the jobs.	◯		◯	◯
tenants/{tenantId}/jobs/{id}/run	Runs a scheduled job.			◯
tenants/{tenantId}/jobs/{id}/script/run	Runs a script.	◯
tenants/{tenantId}/jobs/search	Gets the list of jobs defined by a tenant.			◯
tenants/{tenantId}/jobs/types	Gets the list of job types.			◯
tenants/{tenantId}/rba/categories	Creates and updates an RBA category and gets a list of RBA categories.	◯	◯	◯
tenants/{tenantId}/rba/categories/{categoryId}	Deletes an RBA category.				◯
tenants/{tenantId}/rba/categories/{categoryId}/scripts	Creates and deletes a script and gets a list of scripts for a category.	◯		◯	◯
tenants/{tenantId}/rba/categories/{categoryId}/scripts/{scriptId}	Gets and update the details of a script.	◯		◯
tenants/{tenantId}/rba/scripts/{scriptId}/paginatedOutputs	Gets paginated output logs of a script.			◯

Exports


Resource	Description	POST	PUT	GET	DELETE
exports/tenants/{tenantId}/create	Creates an on-demand batch export template.	◯

Integrations


Resource	Description	POST	PUT	GET	DELETE
tenants/{tenantId}/integrations/activity	Gets the installation activity details of an installed integration activity.			◯
tenants/{tenantId}/integrations/available/{intgId}/emailProps/{entityType}	Gets the email properties of an entity.			◯
tenants/{tenantId}/integrations/available/{intgId}/mappingAttr/{entityType}	Gets the integration mappable properties for an entity.			◯
tenants/{tenantId}/integrations/available/search	Searches available integrations.			◯
tenants/{tenantId}/integrations/events/placeHolders/{entityType}	Gets the integration event placeholders of an entity.			◯
tenants/{tenantId}/integrations/install/AWS	These endpoint IDs are used to install third-party integrations.	◯
tenants/{tenantId}/integrations/install/AZURE	These endpoint IDs are used to install third-party integrations.	◯
tenants/{tenantId}/integrations/install/CUSTOM	Installs a custom integration.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/disable	Disables an installed integration, temporarily disabling the integration services.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/enable	Enables an installed integration.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/event/{eventId}/activate	Activates an integration event.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/event/{eventId}/deactivate	Deactivates an integration event.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/event/{eventId}	Updates, gets, and deletes an integration event.	◯			◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/event	Creates an integration event.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/events	Gets installed integration events.			◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/inbound/authentication	Creates and updates installed integration inbound authentication.	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}	Updates, gets, and deletes the installed integration details.	◯		◯	◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/mappingAttr	Creates, updates, and gets installed integration mapping attributes.	◯		◯
tenants/{tenantId}/integrations/installed/{installedIntgId}/notifier	Creates and updates an installed integration base notifier.	◯
tenants/{tenantId}/integrations/installed/search	Searches for installed integrations.			◯
tenants/{tenantId}/integrations/install/EMAILALERTS	Installs email alert integrations. OpsRamp processes all incoming Alert emails.	◯
tenants/{tenantId}/integrations/install/EMAILINCIDENTS	Installs an email request integration.	◯
tenants/{tenantId}/integrations/install/GOOGLE	These endpoint IDs are used to install third-party integrations.	◯
tenants/{tenantId}/integrations/install/{intgId}	Installs the following integrations:	◯		◯
tenants/{tenantId}/integrations/install/OKTA	Installs a SSO integration.	◯
tenants/{tenantId}/policies/discovery/action/scan/{discoveryProfileId}	Rescans an AWS, Azure, and Google discovery profile.			◯
tenants/{tenantId}/policies/discovery/{discoveryId}	Gets and delete discovery profiles for AWS, Azure, and Google.				◯
tenants/{tenantId}/policies/discovery	Creates and updates AWS, Azure, and Google discovery profiles and gets a list of discovery profiles.	◯	◯	◯
tenants/{tenantId}/policies/discovery/search	Uses a discovery profile name to search for an AWS, Azure, and Google discovery profile.			◯

Knowledge Base


Resource	Description	POST	GET	DELETE
tenants/{tenantId}/kb/article/{articleId}/comment	Adds comments to a KB article.	◯
tenants/{tenantId}/kb/article/{articleId}/comments/{commentId}/resources/{resourceId}	Downloads KB article attachment or comment.		◯
tenants/{tenantId}/kb/article/{articleId}/comments	Gets a list of comments for a KB article.		◯
tenants/{tenantId}/kb/article/{articleId}/delete	Deletes a KB category.			◯
tenants/{tenantId}/kb/article/{articleId}	Gets and updates a KB article.	◯	◯
tenants/{tenantId}/kb/article/{articleId}/resources/{resourceId}	Downloads a KB article attachment.		◯
tenants/{tenantId}/kb/article/{articleId}/share	Shares KB article.	◯
tenants/{tenantId}/kb/{articleId}/activitylog	Gets KB article activity log with provided details.		◯
tenants/{tenantId}/kb/article	Creates a KB article.	◯
tenants/{tenantId}/kb/articlesList	Gets a list of KB articles.		◯
tenants/{tenantId}/kb/articles/search	Searchs for the list of articles in a KB category.		◯
tenants/{tenantId}/kb/category/{categoryId}	Gets a knowledge base category.		◯
tenants/{tenantId}/kb/category/create	Creates a KB category.	◯
tenants/{tenantId}/kb/category/delete/{categoryId}	Deletes a KB category.			◯
tenants/{tenantId}/kb/categorylist/{categoryId}	Gets the list of sub-categories of a knowledge base category.		◯
tenants/{tenantId}/kb/categorylist	Gets list of knowledge base categories.		◯
tenants/{tenantId}/kb/category/restore/{categoryId}	Gets a knowledge base category from TRASH.	◯
tenants/{tenantId}/kb/category/update/{categoryId}	Updates a KB category.	◯
tenants/{tenantId}/kb/template	Creates a KB template.	◯
tenants/{tenantId}/kb/templatesList	Gets the list of KB templates.		◯
tenants/{tenantId}/kb/template/{templateId}/delete	Deletes a KB template.			◯
tenants/{tenantId}/kb/template/{templateId}	Gets KB article template details.		◯

Metrics


Resource	Description	POST	GET
metric/search	Gets the details of metric behavior at a certain time period.		◯
metric/tenants/{tenantId}/metrics/{metric}/metricType	Updates and gets metric type details.		◯
metric/tenants/{tenantId}/{tenantId}/metrictype	The endpoint to assign agent policy for resources.	◯
metric/tenants/{tenantId}/rtypes/{rtype}/resources/{resource}/metrics	Updates and gets resource metrics.	◯	◯

Monitoring


Resource	Description	POST	GET	DELETE
tenants/{tenantId}/monitoring/templates/search	Activates a user.		◯
tenants/{tenantId}/resources/{resourceId}/templates	Assigns, unassigns, and updates resource templates.	◯		◯
tenants/{tenantId}/resources/{resourceId}/templates/search	Gets templates assigned to a resource.		◯
tenants/{tenantId}/resourceMonitors	Creates resource monitors.	◯

Patching


Resource	Description	POST	GET	DELETE
tenants/{tenantId}/patches/baselines/{baselineId}/{action}	Activates and deactivates a patch baseline.	◯
tenants/{tenantId}/patches/baselines/{baselineId}/{patchId}/{action}	Adds and removes patches from a baseline.	◯
tenants/{tenantId}/patches/baselines/{baselineId}	Gets, updates, and deletes patch baselines.	◯	◯	◯
tenants/{tenantId}/patches/baselines	Creates and gets patch baselines.	◯	◯
tenants/{tenantId}/patches/compliance/{complianceId}/baselines/{baselineId}/{action}	Assigns and unassigns a patch baseline attached for a patch compliance check.	◯
tenants/{tenantId}/patches/compliance/{complianceId}/baselines	Gets the baselines attached to a patch compliance.		◯
tenants/{tenantId}/patches/compliance/{complianceId}/deviceGroups/{deviceGrpId}/{action}	Assigns and unassigns a device group for a patch compliance.	◯
tenants/{tenantId}/patches/compliance/{complianceId}/deviceGroups	Gets the device groups attached to a patch compliance.		◯
tenants/{tenantId}/patches/compliance/{complianceId}/devices/{deviceId}/{action}	Assigns and unassigns devices for patch compliance.	◯
tenants/{tenantId}/patches/compliance/{complianceId}/devices	Gets the list of devices attached to a patch compliance.		◯
tenants/{tenantId}/patches/compliance/{complianceId}	Update sand deletes a patch compliance	◯		◯
tenants/{tenantId}/patches/compliance/{complianceId}/run	Runs a patch compliance, checking all devices and device groups for compliance.	◯
tenants/{tenantId}/patches/compliance	Creates a patch compliance and gets the list of patch compliance checks.	◯	◯
tenants/{tenantId}/patches/configurations/{id}	Updates, gets, and deletes a patch configuration.	◯	◯	◯
tenants/{tenantId}/patches/configurations/{id}/run	Runs a patch configuration.	◯
tenants/{tenantId}/patches/configurations	Creates a patch configuration and executes patches on the resources.	◯
tenants/{tenantId}/patches/configurations/search	Searches for patch configurations by a client.		◯
tenants/{tenantId}/patches	Gets a tenant’s list of patches.		◯
tenants/{tenantId}/patches/rating/{intgId}/feed/{patchId}	Gets patch details and delete a patch qualification.		◯
tenants/{tenantId}/patches/{resourceId}/install/status	Gets the patching status of all devices in a patch configuration and display paginated output.		◯
tenants/{tenantId}/patches/{resourceId}/scan/status	Gets the patch scan status of all devices assigned to a missing patch job and display paginated output.		◯
tenants/{tenantId}/resources/patches	Gets the details of installed, missing, or installation-failed patches for a client’s resources.		◯
tenants/{tenantId}/resources/{resourceId}/baselines/{baselineId}/patches	Checks the compliance of a resource against a patch baseline.		◯
tenants/{tenantId}/resources/{resourceId}/patches/install/status	Gets the patching status of a device.		◯
tenants/{tenantId}/resources/{resourceId}/patches/{patchId}/{approvalType}	Approves and disapproves a patch.	◯
tenants/{tenantId}/resources/{resourceId}/patches/scan/status	Gets the details of patch scan status of a device.		◯

Resource Management


Resource	Description	POST	PUT	GET	DELETE
tenants/{mspId}/decommission/{action}	Enables and disables resource decommission at partner level.	◯
tenants/{tenantId}/customAttributes/{attributeId}/assignedEntities/search	Searches for the assigned entities by attribute.			◯
tenants/{tenantId}/customAttributes/{attributeId}	Updates, gets, and deletes tenant custom attributes.	◯		◯	◯
tenants/{tenantId}/customAttributes/{attributeId}/values/{valueId}/devices	Assigns and unassigns custom attributes for devices	◯			◯
tenants/{tenantId}/customAttributes/{attributeId}/values/{valueId}	Updates a custom attribute value description.	◯
tenants/{tenantId}/customAttributes/{attributeId}/values/{valueId}/serviceGroups	Assigns and unassigns custom attributes for service groups	◯
tenants/{tenantId}/customAttributes	Creates a tenant custom attribute type and the list of values	◯
tenants/{tenantId}/customAttributes/search	Searches for tenant custom attribute types and respective values.			◯
tenants/{tenantId}/dependencies/{resourceuuid}	Creates, gets, and deletes resource dependency.	◯		◯	◯
tenants/{tenantId}/deviceGroups/{deviceGroupId}/childs	Assigns and unassigns a child resources for device groups.	◯			◯
tenants/{tenantId}/deviceGroups/{deviceGroupId}/childs/search	Gets the child resources or child device groups within a parent device group.			◯
tenants/{tenantId}/deviceGroups/{deviceGroupId}	Gets device group details and delete sdevice groups.			◯	◯
tenants/{tenantId}/deviceGroups/minimal	Gets minimal details of device groups.			◯
tenants/{tenantId}/deviceGroups	Creates and updates device groups.	◯
tenants/{tenantId}/deviceGroups/search	Gets the root level device groups.			◯
tenants/{tenantId}/devices/{deviceId}/customAttributes	Gets device custom attributes.			◯
tenants/{tenantId}/devices/{deviceId}/deviceWarranty	Creates a device warranty and gets device warranty details.	◯		◯
tenants/{tenantId}/devices/wsussettings/{action}	The endpoint to assign agent policy for resources.	◯
tenants/{tenantId}/deviceWarranties	Gets the details of multiple device warranties.			◯
tenants/{tenantId}/history/resources/{resourceId}	Gets the data of a decommissioned resource.			◯
tenants/{tenantId}/history/resources	Gets the list of decommissioned resources.			◯
tenants/{tenantId}/policies/management/{id}/action/run	Runs a device management policy.			◯
tenants/{tenantId}/policies/management/{id}	The endpoint is used to get device management policy details and unassign agent policy for resources.			◯	◯
tenants/{tenantId}/policies/management	Creates and updates device management policies, and gets tenant device management policies, without pagination.	◯	◯	◯
tenants/{tenantId}/policies/management/search	Searches for a device management policy with a policy name.			◯
tenants/{tenantId}/resources/antivirus/search	Gets the latest antivirus definitions installed on resources.			◯
tenants/{tenantId}/resources/minimal	Gets minimal resource details.			◯
tenants/{tenantId}/resources/{resourceId}/applications	Gets the list of applications running on a resource.			◯
tenants/{tenantId}/resources/{resourceId}/availability	Gets the availability details of a resource within a specific time frame.			◯
tenants/{tenantId}/resources/{resourceId}/availability/rule	Updates and gets the availability rule defined on a resource.	◯		◯
tenants/{tenantId}/resources/{resourceId}/decommission	Decommissions a resource.	◯
tenants/{tenantId}/resources/{resourceId}/notes/{noteId}	Updates a resource note.	◯
tenants/{tenantId}/resources/{resourceId}/notes	Creates a resource note.	◯
tenants/{tenantId}/resources/{resourceId}/notes/search	Gets the latest antivirus definitions installed on resources.			◯
tenants/{tenantId}/resources/{resourceId}	Gets resource information, update resource details, and delete a resource using a resource ID.	◯		◯	◯
tenants/{tenantId}/resources	Creates a generic resource.	◯
tenants/{tenantId}/resources/Resourcetype/{resourceType}/{identity}	Deletes a resource based on resource type.				◯
tenants/{tenantId}/resources/search	Gets the resources of a partner or a client.			◯
tenants/{tenantId}/resourceType/minimal	Gets minimal resource type details.			◯
tenants/{tenantId}/serviceGroups/link	Links or shares an existing service group with other service groups.	◯
tenants/{tenantId}/serviceGroups/minimal	Gets minimal details (including service group ID and name) of service groups.			◯
tenants/{tenantId}/serviceGroups	Creates or updates a service group.	◯
tenants/{tenantId}/serviceGroups/search	Gets root-level, parent service groups.			◯
tenants/{tenantId}/serviceGroups/{serviceGroupId}/customAttributes	Gets service group custom attributes.			◯
tenants/{tenantId}/serviceGroups/{sgId}/childs	Assigns and unassigns child resources for a service group.	◯			◯
tenants/{tenantId}/serviceGroups/{sgId}/childs/search	Gets the child entities (resources or service groups) of a parent service group.			◯
tenants/{tenantId}/serviceGroups/{sgId}	Gets and delete service groups.			◯
tenants/{tenantId}/serviceGroups/unLink/{parentSgId}/{childSgId}	Unlinks a child service group from a parent service group.				◯
tenants/{tenantId}/services/{serviceId}/availability	Gets availability details of a service.			◯
tenants/{tenantId}/sites/minimal	Gets minimal details of sites.			◯
tenants/{tenantId}/sites	Creates a site to organize devices based on location.	◯
tenants/{tenantId}/sites/search	Searches sites.			◯
tenants/{tenantId}/sites/{siteId}	Updates and gets site details, and deletes a site.	◯		◯	◯
tenants/{tenantId}/topology/{resourceUUID}	Gets topology data by providing relationship information about resources.			◯
tenants/{varId}/clients/{clientId}/customAttributes	Gets client custom attributes.			◯
tenants/{varId}/customAttributes/{attributeId}/values/{valueId}/clients	Assigns and unassigns client custom attributes.	◯			◯

Tenancy and Access Controls


Resource	Description	POST	GET	DELETE
cfg/alertSource/available/custIntg/{intgId}	Gets the list of available custom (and email alert integration) alert sources.		◯
cfg/countries	Gets the list of countries based on country code.		◯
cfg/tenants/channels	Gets the list of channels.		◯
cfg/tenants/nocs	Gets the list of NOCs of a tenant.		◯
cfg/timezones	Gets the list of timezones.		◯
tenants/{orgId}/users/minimal	Gets the minimal details of the users.		◯
tenants/{orgId}/users	Creates a user.	◯
tenants/{orgId}/users/{userId}/changePassword	Changes the password.	◯
tenants/{orgId}/users/{userId}	Updates and gets user details.	◯
tenants/{tenantId}/credentialSets/{credentialSetId}	Updates, gets, and deletes a credential set by ID.	◯	◯	◯
tenants/{tenantId}/credentialSets/minimal	Gets the minimal details of client credential sets.		◯
tenants/{tenantId}/credentialSets	Creates and gets a credential set.	◯	◯
tenants/{tenantId}/devices/{deviceId}/credentialSets/minimal	Gets the minimal details of client credential sets.		◯
tenants/{tenantId}/notes/{noteId}/	Updates, gets, and deletes a client note.	◯	◯	◯
tenants/{tenantId}/notes/search	Searches for client notes.		◯
tenants/{tenantId}/notes	Creates client notes.	◯
tenants/{tenantId}/permissionSets	Gets the list of permission sets assigned to a tenant.		◯
tenants/{tenantId}/roles/{roleId}	Updates, gets, and deletes roles.	◯		◯
tenants/{tenantId}/roles/search	Gets roles under a partner or client.		◯
tenants/{tenantId}/roles	Creates a partner- or client-level role.	◯
tenants/{tenantId}/userGroups	Creates a partner- or client-level user group, and searches user groups.	◯	◯
tenants/{tenantId}/userGroups/{userGroupId}	Updates, gets, and deletes user groups.	◯	◯	◯
tenants/{tenantId}/userGroups/{userGroupId}/users	Adds, gets, and deletes users for a user group.	◯	◯	◯
tenants/{tenantId}/users/loginHistory/search	Gets the user login history.		◯
tenants/{tenantId}/users/search	Gets users for a tenant.		◯
tenants/{tenantId}/users/{userId}/{action}	The endpoint to assign agent policy for resources.	◯
tenants/{varId}/clients/{clientId}/{action}	Activates and deactivates a client.	◯
tenants/{varId}/clients/{clientId}	Updates and gets client details.	◯	◯
tenants/{varId}/clients/minimal	Gets the minimal details of clients.		◯
tenants/{varId}/clients/search	Searches for clients.		◯
tenants/{varId}/clients	Creates a client.	◯
tenants/{varId}	This API is used to get details of a partner.		◯

Tickets


Resource	Description	POST	GET	DELETE
tenants/{tenantId}/changeRequests/categories	Creates categories for the change request entity type.	◯
tenants/{tenantId}/changeRequests/categories/{uniqueId}	Updates a category of the change request entity type.	◯
tenants/{tenantId}/changeRequests/{changeRequestId}/activitylog	Gets user activities on a change request.		◯
tenants/{tenantId}/changeRequests/{changeRequestId}/close	Closes a change request.	◯
tenants/{tenantId}/changeRequests/{changeRequestId}/responses/{responseId}/resources/{resourceId}	Downloads the response attachment attached to a change request.		◯
tenants/{tenantId}/changeRequests/{changeRequestId}/responses/search	Gets responses of a change request.		◯
tenants/{tenantId}/changeRequests/{changeRequestId}/responses	Adds a response to a change request.	◯
tenants/{tenantId}/changeRequests/{changeRequestId}	Gets and update change requests.	◯	◯
tenants/{tenantId}/changeRequests/customForm	Gets the custom form for a change request.		◯
tenants/{tenantId}/changeRequests/search	Searches for change requests.		◯
tenants/{tenantId}/changeRequests	Creates a change request.	◯
tenants/{tenantId}/customFields/{classCode}/{customFieldId}	Gets the details of a custom field.		◯
tenants/{tenantId}/customFields/{classCode}	Gets details of custom fields attached to an entity.		◯
tenants/{tenantId}/incidents/businessImpacts	Creates and gets an incident business impact.		◯
tenants/{tenantId}/incidents/businessImpacts/{uniqueId}	Updates incident business impact.	◯
tenants/{tenantId}/incidents/categories	Creates categories for the incident entity type.	◯
tenants/{tenantId}/incidents/categories/{uniqueId}	Updates a category of entity type incident.	◯
tenants/{tenantId}/incidents/customForm	Gets the custom form for an incident.		◯
tenants/{tenantId}/incidents/forwardMapping	Creates, updates, and gets forward mapping.	◯
tenants/{tenantId}/incidents/{incidentId}/activitylog	Gets user activities on an incident.		◯
tenants/{tenantId}/incidents/{incidentId}/close	Closes an incident.	◯
tenants/{tenantId}/incidents/{incidentId}/responses/{responseId}/resources/{resourceId}	Downloadsthe response attached to an incident.		◯
tenants/{tenantId}/incidents/{incidentId}/responses/search	Gets responses of an incident.		◯
tenants/{tenantId}/incidents/{incidentId}/responses	Adds a response to an incident.	◯
tenants/{tenantId}/incidents/{incidentId}	Updates and Gets incidents.	◯	◯
tenants/{tenantId}/incidents/reverseMapping	Creates, updates, and gets reverse mappings.	◯	◯
tenants/{tenantId}/incidents/search	Searches for incidents.		◯
tenants/{tenantId}/incidents	Creates an incident.	◯
tenants/{tenantId}/incidents/urgencies	Create and gets urgencies for an incident.	◯	◯
tenants/{tenantId}/incidents/urgencies/{uniqueId}	Updates urgency.	◯
tenants/{tenantId}/problems/categories	Creates categories for the problem entity type.	◯
tenants/{tenantId}/problems/categories/{uniqueId}	Updates a category of the entity type problem.	◯
tenants/{tenantId}/problems/customForm	Gets the custom form for a problem.		◯
tenants/{tenantId}/problems/{problemId}/activitylog	Gets user activities on a problem.		◯
tenants/{tenantId}/problems/{problemId}/close	Closes a problem.	◯
tenants/{tenantId}/problems/{problemId}/responses/{responseId}/resources/{resourceId}	Downloads the response attached to a problem.		◯
tenants/{tenantId}/problems/{problemId}/responses/search	Gets responses of a problem.		◯
tenants/{tenantId}/problems/{problemId}/responses	Adds a response to a problem.	◯
tenants/{tenantId}/problems/{problemId}	Updates and gets a problem	◯	◯
tenants/{tenantId}/problems/search	Searches problems.		◯
tenants/{tenantId}/problems	Creates a problem.	◯
tenants/{tenantId}/serviceRequests/categories	Creates categories for the service request entity type.	◯
tenants/{tenantId}/serviceRequests/categories/{uniqueId}	Updates a category of entity type service request.	◯
tenants/{tenantId}/serviceRequests/customForm	Gets the custom form for a service request.		◯
tenants/{tenantId}/serviceRequests/search	Searches for service requests.		◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}/activitylog	Gets user activities on a service request.		◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}/close	Closes a service request.	◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}/responses/{responseId}/resources/{resourceId}	Downloads the response attached to a service request.		◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}/responses/search	Gets responses of a service request.		◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}/responses	Adds a response to a service request.	◯
tenants/{tenantId}/serviceRequests/{serviceRequestId}	Updates and gets a service request.		◯
tenants/{tenantId}/serviceRequests	Creates a service request.	◯
tenants/{tenantId}/tasks/search	Searches tasks.		◯
tenants/{tenantId}/tasks/{taskId}/activitylog	Gets a list of user activities on a task..		◯
tenants/{tenantId}/tasks/{taskId}/close	Closes a task.	◯
tenants/{tenantId}/tasks/{taskId}/responses/{responseId}/resources/{resourceId}	Downloads the response attached to a task.		◯
tenants/{tenantId}/tasks/{taskId}/responses/search	Gets responses of a task.		◯
tenants/{tenantId}/tasks/{taskId}/responses	Adds a response to a task.	◯
tenants/{tenantId}/tasks/{taskId}	Updates and gets tasks.	◯	◯
tenants/{tenantId}/tasks	Creates a task.	◯
tenants/{tenantId}/{ticketType}/categories/{parentCategoryId}	Gets the list of categories for an entity type.		◯
tenants/{tenantId}/{ticketType}/slaPolicies/{id}	Gets the details of a service level agreement policy.		◯
tenants/{tenantId}/{ticketType}/slaPolicies/search	Gets a list of all service level agreement policies along with their details.		◯
tenants/{tenantId}/{ticketType}/statusReasons	Gets ticket status change reasons.		◯
tenants/{tenantId}/{ticketType}/{ticketId}/notes/{noteId}	Updates, gets, and deletes ticket notes by ID.	◯	◯	◯
tenants/{tenantId}/{ticketType}/{ticketId}/notes	Creates and gets ticket notes.	◯	◯
tenants/{tenantId}/timeBoundRequests/customForm	Gets the custom form for a time-bound request.		◯
tenants/{tenantId}/timeBoundRequests/search	Searches for time bound requests.		◯
tenants/{tenantId}/timeBoundRequests	Creates a time bound request.	◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/activitylog	Gets user activities on a time bound request.		◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/close	Closes a time bound request.	◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/responses/{responseId}/resources/{resourceId}	Downloads the response attached to a time bound request.		◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/responses/search	Gets responses of a time bound request.		◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}/responses	Adds a response to a time bound request.	◯
tenants/{tenantId}/timeBoundRequests/{timeBoundRequestId}	Updates and gets time bound requests.	◯	◯