Skip to main content

Administration

251 endpoints.

PATCH /api/v1/organizations/vuln_analysis​

Toggle Vuln Analysis

Request body: HandleToggleVulnAnalysisRequest

Responses: 200, 400, 401, 500

GET /api/v1/organizations/{id}/billing-profile​

Get Organization Billing Profile

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/organizations/{id}/billing-profile​

Update Organization Billing Profile

ParameterInRequiredDescription
idpathyesid identifier

Request body: OrganizationBillingProfile

Responses: 200, 400, 401, 500

Scanner Profiles​

GET /api/v1/administration/scanner_profiles​

List Scan Profiles

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/scanner_profiles​

Create Scan Profile

Request body: ScanProfile

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/scanner_profiles/{id}​

Delete Scan Profile

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/scanner_profiles/{id}​

Get Scan Profile

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/scanner_profiles/{id}​

Update Scan Profile

ParameterInRequiredDescription
idpathyesid identifier

Request body: ScanProfileUpdate

Responses: 200, 400, 401, 500

Scanner Profiles / Host Discovery​

GET /api/v1/administration/scanner_profiles/{profile_id}/host_discovery​

Get Host Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/scanner_profiles/{profile_id}/host_discovery​

Create Host Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Request body: HostDiscovery

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/scanner_profiles/{profile_id}/host_discovery/{id}​

Delete Host Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/scanner_profiles/{profile_id}/host_discovery/{id}​

Update Host Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Request body: HostDiscovery

Responses: 200, 400, 401, 500

Scanner Profiles / Service Discovery​

GET /api/v1/administration/scanner_profiles/{profile_id}/service_discovery​

Get Service Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/scanner_profiles/{profile_id}/service_discovery​

Create Service Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Request body: ServiceDiscovery

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/scanner_profiles/{profile_id}/service_discovery/{id}​

Delete Service Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/scanner_profiles/{profile_id}/service_discovery/{id}​

Update Service Discovery

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Request body: ServiceDiscovery

Responses: 200, 400, 401, 500

Scanner Profiles / Credentials​

GET /api/v1/administration/scanner_profiles/{profile_id}/credentials​

Get Credentials

List credentials for a scan profile

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/scanner_profiles/{profile_id}/credentials​

Create Credentials

Create credentials for a scan profile

ParameterInRequiredDescription
profile_idpathyesprofile id identifier

Request body: CredentialInput

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/scanner_profiles/{profile_id}/credentials/{id}​

Delete Credentials

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/scanner_profiles/{profile_id}/credentials/{id}​

Update Credentials

Update credentials for a scan profile

ParameterInRequiredDescription
profile_idpathyesprofile id identifier
idpathyesid identifier

Request body: CredentialInput

Responses: 200, 400, 401, 500

Subnets​

GET /api/v1/administration/networks/subnets​

List Subnets

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/networks/subnets​

Create Subnet

Request body: Subnet

Responses: 200, 400, 401, 500

GET /api/v1/administration/networks/subnets/search​

Search Subnets

Search subnets by CIDR

ParameterInRequiredDescription
searchqueryyesSearch query

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/networks/subnets/{id}​

Delete Subnet

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/networks/subnets/{id}​

Get Subnet

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/networks/subnets/{id}​

Update Subnet

ParameterInRequiredDescription
idpathyesid identifier

Request body: Subnet

Responses: 200, 400, 401, 500

URLs​

GET /api/v1/administration/networks/urls​

List UR Ls

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/networks/urls​

Create URL

Request body: NetworkURL

Responses: 200, 400, 401, 500

GET /api/v1/administration/networks/urls/search​

Search UR Ls

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page
searchqueryyesSearch query

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/networks/urls/{id}​

Delete URL

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/networks/urls/{id}​

Get URL

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Zones​

GET /api/v1/administration/zones​

List Zones

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/zones/search​

Search Zones

Search zones by name

ParameterInRequiredDescription
searchqueryyesSearch query

Responses: 200, 400, 401, 500

Zones / Bindings​

POST /api/v1/administration/zones​

Create Zone

Request body: Zone

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/bindings​

Apply Zone Bindings

Request body: ZoneBindingApply

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{id}​

Delete Zone

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/zones/{id}​

Get Zone

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/zones/{id}​

Update Zone

ParameterInRequiredDescription
idpathyesid identifier

Request body: ZoneUpdate

Responses: 200, 400, 401, 500

Zones / Blackout Windows​

GET /api/v1/administration/zones/{zone_id}/blackout_windows​

List Blackout Windows

List blackout windows for a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/{zone_id}/blackout_windows​

Add Black Out Windows

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Request body: BlackoutWindowCreate

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/blackout_windows/{id}​

Delete Black Out Windows

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/zones/{zone_id}/blackout_windows/{id}​

Update Blackout Window

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Request body: BlackoutWindowUpdate

Responses: 200, 400, 401, 500

Zones / Recurring Blackout Windows​

GET /api/v1/administration/zones/{zone_id}/recurring_blackout_windows​

List Recurring Blackout Windows

List recurring blackout windows for a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/{zone_id}/recurring_blackout_windows​

Add Recurring Black Out Windows

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Request body: RecurringBlackoutWindowCreate

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/recurring_blackout_windows/{id}​

Delete Recurring Black Out Windows

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/zones/{zone_id}/recurring_blackout_windows/{id}​

Update Recurring Blackout Window

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Request body: RecurringBlackoutWindowUpdate

Responses: 200, 400, 401, 500

Zones / Excluded Hosts​

POST /api/v1/administration/zones/excluded_hosts​

Add Excluded Host

Request body: ZoneExcludedHostCreate

Responses: 200, 400, 401, 500

GET /api/v1/administration/zones/{zone_id}/excluded_hosts​

List Excluded Hosts

List excluded hosts for a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/excluded_hosts/{id}​

Delete Excluded Host

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

Zones / Subnets​

GET /api/v1/administration/zones/{zone_id}/subnets​

List Zone Subnets

List subnets assigned to a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/{zone_id}/subnets​

Add Zone Subnet

Add a subnet to a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Request body: HandleAddZoneSubnetRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/subnets/{id}​

Delete Zone Subnet

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

Zones / URLs​

GET /api/v1/administration/zones/{zone_id}/urls​

List Zone UR Ls

List URLs assigned to a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/{zone_id}/urls​

Add Zone URL

Add a URL to a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Request body: HandleAddZoneURLRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/urls/{id}​

Delete Zone URL

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

Zones / Vulnerability Scan​

POST /api/v1/administration/zones/{zone_id}/scan/vulnerability​

Trigger Vulnerability Scan

Trigger a vulnerability scan for a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

Zones / Scan Schedules​

GET /api/v1/administration/scan_schedules/{id}​

Get Scan Schedule

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/zones/{zone_id}/scan_schedules​

List Scan Schedules By Zone

List scan schedules for a zone

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/zones/{zone_id}/scan_schedules​

Create Scan Schedule

ParameterInRequiredDescription
zone_idpathyeszone id identifier

Request body: ScanScheduleCreate

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/zones/{zone_id}/scan_schedules/{id}​

Delete Scan Schedule

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/zones/{zone_id}/scan_schedules/{id}​

Update Scan Schedule

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Request body: ScanScheduleUpdate

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/zones/{zone_id}/scan_schedules/{id}/toggle​

Toggle Scan Schedule

Toggle a scan schedule on/off

ParameterInRequiredDescription
zone_idpathyeszone id identifier
idpathyesid identifier

Request body: HandleToggleScanScheduleRequest

Responses: 200, 400, 401, 500

Tags​

GET /api/v1/administration/tags​

List Tags

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/tags/search​

Search Tags

Search tags by name

ParameterInRequiredDescription
searchqueryyesSearch query

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/tags/{id}​

Update Tags

ParameterInRequiredDescription
idpathyesid identifier

Request body: TagUpdate

Responses: 200, 400, 401, 500

Domains​

GET /api/v1/administration/networks/domains​

List Domains

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/networks/domains​

Create Domain

Request body: Domain

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/networks/domains/{id}​

Delete Domain

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/networks/domains/{id}​

Get Domain

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Files​

GET /api/v1/administration/files​

List Organization Files

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/files​

Upload Organization File

Upload an organization file

Request body required.

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/files/{id}​

Delete Organization File

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/files/{id}​

Get Organization File

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/files/{id}/download​

Download Organization File

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Users​

GET /api/v1/administration/users​

Administration Administration List Users

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/users​

Administration Administration Create User

Request body: User

Responses: 200, 400, 401, 500

GET /api/v1/administration/users/my/assignments​

Get My Assignment Counts

Get counts of open items assigned to the current user

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/users/ssh_key​

Update User Ssh Key

Update the current user's SSH key

Request body: UserSshKeyUpdate

Responses: 200, 400, 401, 500

POST /api/v1/administration/users/sync​

Sync User

Sync the current user from identity provider

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/users/view_filter​

Update User View Filter

Update the current user's view filter

Request body: UserViewFilterUpdate

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/users/{id}​

Administration Administration Delete User

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/users/{id}​

Administration Administration Get User

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/users/{id}​

Administration Administration Update User

ParameterInRequiredDescription
idpathyesid identifier

Request body: UserUpdate

Responses: 200, 400, 401, 500

GET /api/v1/governance/users/{id}/business_units​

Get User Business Units

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/governance/users/{id}/business_units​

Assign User Business Units

ParameterInRequiredDescription
idpathyesid identifier

Request body: HandleAssignUserBusinessUnitsRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/governance/users/{id}/business_units/{bu_id}​

Remove User Business Unit

ParameterInRequiredDescription
idpathyesid identifier
bu_idpathyesbu id identifier

Responses: 200, 400, 401, 500

POST /api/v1/governance/users/{id}/business_units/{bu_id}​

Add User Business Unit

ParameterInRequiredDescription
idpathyesid identifier
bu_idpathyesbu id identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/users​

Platform-administration Platform-administration List Users

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/users​

Platform-administration Platform-administration Create User

Request body: User

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/users/{id}​

Platform-administration Platform-administration Delete User

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/users/{id}​

Platform-administration Platform-administration Get User

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/users/{id}​

Platform-administration Platform-administration Update User

ParameterInRequiredDescription
idpathyesid identifier

Request body: UserUpdate

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/users/{id}/switch_orgs/{org_id}​

Switch Orgs

Switch a user to a different organization

ParameterInRequiredDescription
idpathyesid identifier
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

Identity Providers​

GET /api/v1/administration/identity_providers​

Administration Administration List Identity Providers

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/identity_providers​

Create Identity Provider

Request body: IdentityProviderCreate

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/identity_providers/{alias}​

Delete Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/identity_providers/{alias}​

Administration Administration Get Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/identity_providers/{alias}​

Update Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Request body: IdentityProviderUpdate

Responses: 200, 400, 401, 500

GET /api/v1/iem/inventory/identity-providers​

Iem Iem List Identity Providers

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/iem/inventory/identity-providers/{id}​

Iem Iem Get Identity Provider

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/identity_providers​

List Admin Identity Providers

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/identity_providers​

Create Admin Identity Provider

Request body: IdentityProviderCreate

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/identity_providers/{alias}​

Delete Admin Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/identity_providers/{alias}​

Get Admin Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/identity_providers/{alias}​

Update Admin Identity Provider

ParameterInRequiredDescription
aliaspathyesalias identifier

Request body: IdentityProviderUpdate

Responses: 200, 400, 401, 500

Notifications​

GET /api/v1/administration/notification_settings​

List Notification Settings

List notification settings for the organization

Responses: 200, 400, 401, 500

POST /api/v1/administration/notification_settings​

Create Notification Setting

Request body: NotificationSettingsCreateRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/notification_settings/{id}​

Delete Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/notification_settings/{id}​

Get Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/notification_settings/{id}​

Update Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Request body: OrganizationNotificationSettingsUpdate

Responses: 200, 400, 401, 500

GET /api/v1/global_notification_settings​

List Global Notification Settings

List global notification settings

Responses: 200, 400, 401, 500

POST /api/v1/global_notification_settings​

Create Global Notification Setting

Request body: NotificationSettingsCreateRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/global_notification_settings/{id}​

Delete Global Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/global_notification_settings/{id}​

Get Global Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/global_notification_settings/{id}​

Update Global Notification Setting

ParameterInRequiredDescription
idpathyesid identifier

Request body: GlobalNotificationSettingsUpdate

Responses: 200, 400, 401, 500

Remediation SLA​

GET /api/v1/governance/remediation-sla​

Get Remediation SLA

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/governance/remediation-sla​

Upsert Remediation SLA

Responses: 200, 400, 401, 500

DELETE /api/v1/governance/remediation-sla/business-units/{buId}​

Delete BU Override

ParameterInRequiredDescription
buIdpathyesbuId identifier

Responses: 200, 400, 401, 500

GET /api/v1/governance/remediation-sla/business-units/{buId}​

Get BU Override

ParameterInRequiredDescription
buIdpathyesbuId identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/governance/remediation-sla/business-units/{buId}​

Upsert BU Override

ParameterInRequiredDescription
buIdpathyesbuId identifier

Responses: 200, 400, 401, 500

Entitlements​

GET /api/v1/administration/entitlements​

Get Entitlements

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/devsecops/applications​

Add Dast Application

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/entitlements/devsecops/applications/{id}​

Delete Dast Application

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Entitlements / Identity Exposure Management​

POST /api/v1/administration/entitlements/iem/domains​

Add IEM Domain

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/entitlements/iem/domains/{id}​

Delete IEM Domain

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/iem/executives​

Add IEM Executive

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/entitlements/iem/executives/{id}​

Delete IEM Executive

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/iem/vendors​

Add IEM Vendor

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/entitlements/iem/vendors/{id}​

Delete IEM Vendor

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Entitlements / Subscription​

GET /api/v1/administration/billing-profile​

Get Own Billing Profile

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/billing-profile​

Update Own Billing Profile

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription​

Get Subscription

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription​

Create Subscription

Request body: HandleCreateSubscriptionRequest

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription/addons​

Add Subscription Addon

Request body: HandleAddSubscriptionAddonRequest

Responses: 200, 400, 401, 500

DELETE /api/v1/administration/entitlements/subscription/addons/{code}​

Remove Subscription Addon

ParameterInRequiredDescription
codepathyescode identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/billing​

Get Billing Info

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/entitlements/subscription/billing​

Update Billing Info

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/billing-history​

Get Billing History

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription/cancel​

Cancel Subscription

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/collection-policy​

Get Collection Policy

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/invoices​

Get Invoices

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/entitlements/subscription/payment-method​

Update Payment Method

Responses: 200, 400, 401, 500

PATCH /api/v1/administration/entitlements/subscription/plan​

Change Plan

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/plans​

Get Sign Up Plans

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/usage​

Get Usage

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/usage/forecast​

Get Usage Forecast

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/usage/history​

Get Usage History

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/billing/catalog​

Get Billing Catalog

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/billing/credit-packs/purchase​

Purchase Credit Pack

Responses: 200, 400, 401, 500

GET /api/v1/credit-packages​

Get Credit Packages

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Entitlements / Quotes​

GET /api/v1/administration/entitlements/subscription/quotes​

List Org Quotes

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/quotes/{id}​

Get Org Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription/quotes/{id}/accept​

Accept Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription/quotes/{id}/decline​

Decline Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/quotes/{id}/document​

Download Org Quote Document

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Entitlements / Credits​

GET /api/v1/administration/entitlements/subscription/credits​

List Credit Balances

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/administration/entitlements/subscription/credits/{id}/ledger​

Get Credit Ledger

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Entitlements / SLA​

GET /api/v1/administration/entitlements/subscription/sla​

Get SLA Terms

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/administration/entitlements/subscription/sla/customization​

Request SLA Customization

Request body: HandleRequestSLACustomizationRequest

Responses: 200, 400, 401, 500

Organizations​

GET /api/v1/organizations​

Organizations Organizations List Organizations

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/organizations​

Organizations Organizations Create Organization

Request body: Organization

Responses: 200, 400, 401, 500

DELETE /api/v1/organizations/{id}​

Organizations Organizations Delete Organization

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/organizations/{id}​

Organizations Organizations Get Organization

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/organizations/{id}​

Organizations Organizations Update Organization

ParameterInRequiredDescription
idpathyesid identifier

Request body: OrganizationUpdate

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/organizations​

Platform-administration Platform-administration List Organizations

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/organizations​

Platform-administration Platform-administration Create Organization

Request body: Organization

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/organizations/{id}​

Platform-administration Platform-administration Delete Organization

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/organizations/{id}​

Platform-administration Platform-administration Get Organization

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/organizations/{id}​

Platform-administration Platform-administration Update Organization

ParameterInRequiredDescription
idpathyesid identifier

Request body: OrganizationUpdate

Responses: 200, 400, 401, 500

Get Organization Logo

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Upload Organization Logo

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Resource Utilization​

GET /api/v1/platform-administration/siem/usage​

Get Siem Usage

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/siem/usage/by-source​

Get Siem Usage By Source

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/siem/usage/{id}​

Get Siem Usage For Org

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Audit Logs​

GET /api/v1/platform-administration/audit-logs​

Platform-administration Platform-administration List Audit Logs

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/audit-logs/export/xlsx​

Export Audit Logs Xlsx

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/audit-logs/{id}​

Get Audit Log

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/security-operations/investigations/identity-activity/audit-logs​

Security-operations Security-operations List Audit Logs

List admin / directory change actions (today: Entra audit)

Responses: 200, 400, 401, 500

Billing​

POST /api/v1/platform-administration/billing/billing-sync​

Billing Sync

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/clients​

Get MSP Clients

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/clients/{org_id}​

Get MSP Client Detail

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/clients/{org_id}/snapshots​

Get Client Snapshots

ParameterInRequiredDescription
org_idpathyesorg id identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/clients/{org_id}/transition​

Assign Transition Plan

ParameterInRequiredDescription
org_idpathyesorg id identifier

Request body: HandleAssignTransitionPlanRequest

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/pool​

Get Pool Utilization

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/revenue​

Get Revenue Report

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/visible-plans​

Get Admin Visible Plans

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Billing / Plan Catalogs​

GET /api/v1/billing/plan-addons​

Billing Billing List All Plan Addons

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/plan-addons​

Platform-administration Platform-administration List All Plan Addons

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/plans​

Get All Plans

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/plans​

Create Plan

Request body: CreatePlanInput

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/plans/{id}​

Deactivate Plan

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/plans/{id}​

Get Plan Detail

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/billing/plans/{id}​

Update Plan

ParameterInRequiredDescription
idpathyesid identifier

Request body: PlanCatalogUpdate

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/plans/{id}/addons​

Get Plan Addons

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/plans/{id}/addons​

Attach Plan Addon

ParameterInRequiredDescription
idpathyesid identifier

Request body: PlanAddonAttach

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/plans/{id}/addons/{addon_item_id}​

Detach Plan Addon

ParameterInRequiredDescription
idpathyesid identifier
addon_item_idpathyesaddon item id identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/billing/plans/{id}/addons/{addon_item_id}​

Update Plan Addon

ParameterInRequiredDescription
idpathyesid identifier
addon_item_idpathyesaddon item id identifier

Request body: PlanAddonUpdate

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/plans/{id}/permanent​

Delete Plan Permanent

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Billing / Addon Items​

GET /api/v1/platform-administration/billing/gates​

Get Gate Catalog

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/gates​

Upsert Gate

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/spycloud-usage​

Get Spy Cloud Usage

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Billing / Overage Rate Cards​

GET /api/v1/platform-administration/billing/addon-items​

Get Addon Items

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/addon-items​

Create Addon Item

Request body: CreateAddonItemInput

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/addon-items/{id}​

Deactivate Addon Item

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/addon-items/{id}​

Get Addon Item Detail

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/billing/addon-items/{id}​

Update Addon Item

ParameterInRequiredDescription
idpathyesid identifier

Request body: AddonItemUpdate

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/overage-rate-cards​

Get Overage Rate Cards

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/overage-rate-cards​

Upsert Overage Rate Card

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/overage-rate-cards/{id}​

Delete Overage Rate Card Override

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/organizations/{id}/billing-policy​

Set Org Billing Policy

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/organizations/{id}/overages​

Update Contract Overages

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Billing / Settings​

GET /api/v1/platform-administration/billing/settings​

Get Billing Settings

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/billing/settings​

Update Billing Settings Admin

Responses: 200, 400, 401, 500

Get Company Logo

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Upload Company Logo

Responses: 200, 400, 401, 500

Billing / Quotes​

GET /api/v1/platform-administration/billing/quotes​

List Quotes

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/quotes​

Create Quote

Request body: CreateQuoteInput

Responses: 200, 400, 401, 500

DELETE /api/v1/platform-administration/billing/quotes/{id}​

Delete Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/quotes/{id}​

Get Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/billing/quotes/{id}​

Update Quote

ParameterInRequiredDescription
idpathyesid identifier

Request body: UpdateQuoteInput

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/quotes/{id}/clone​

Clone Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/billing/quotes/{id}/document​

Download Quote Document

ParameterInRequiredDescription
idpathyesid identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/billing/quotes/{id}/send​

Send Quote

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

Billing / SLA​

GET /api/v1/platform-administration/sla/requests​

Get Pending SLA Requests

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/sla/requests/{id}​

Get SLA Request By ID

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/sla/requests/{id}​

Review SLA Request

ParameterInRequiredDescription
idpathyesid identifier

Request body: HandleReviewSLARequestRequest

Responses: 200, 400, 401, 500

Billing / SLA Overrides​

GET /api/v1/platform-administration/sla/effective/{org_id}​

Get Org Effective SLA

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/sla/overrides/{org_id}​

Get Org SLA Override

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

Billing / Licensing​

POST /api/v1/platform-administration/organizations/{id}/credit-grants​

Grant Organization Credits

ParameterInRequiredDescription
idpathyesid identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/organizations/{org_id}/entitlements​

Get Entitlements By Org ID

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

PATCH /api/v1/platform-administration/organizations/{org_id}/entitlements​

Update Entitlements

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

Billing / Metering​

POST /api/v1/platform-administration/metering/billing/snapshot​

Trigger Billing Snapshot

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/metering/rollups/daily​

Trigger Daily Rollup

Responses: 200, 400, 401, 500

POST /api/v1/platform-administration/metering/rollups/monthly​

Trigger Monthly Rollup

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/metering/usage/{org_id}​

Get Usage By Org

ParameterInRequiredDescription
org_idpathyesorg id identifier

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/metering/usage/{org_id}/history​

Get Usage History By Org

ParameterInRequiredDescription
org_idpathyesorg id identifier
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

Engagements​

POST /api/v1/agent/communicate​

Agent Agent Communicate

Request body: AgentWithDetails

Responses: 200, 400, 401, 500

POST /api/v1/agent/logs​

Agent Logs

Responses: 200, 400, 401, 500

POST /api/v1/linux_agent/communicate​

Linux Agent Linux Agent Communicate

Request body: AgentWithDetails

Responses: 200, 400, 401, 500

POST /api/v1/linux_agent/logs​

Linux Agent Logs

Responses: 200, 400, 401, 500

POST /api/v1/macos_agent/communicate​

Macos Agent Macos Agent Communicate

Request body: AgentWithDetails

Responses: 200, 400, 401, 500

POST /api/v1/macos_agent/logs​

Macos Agent Logs

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/calendar/events​

Get Admin Calendar Events

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements​

Get Admin Engagements

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements/aggregations​

Get Admin Engagement Aggregations

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements/requests​

Get Admin Pending Requests

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements/sla​

Get SLA Summary

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements/stats​

Get Admin Engagement Stats

Responses: 200, 400, 401, 500

GET /api/v1/platform-administration/engagements/utilization​

Get Staff Utilization

ParameterInRequiredDescription
paginateFromquerynoPagination offset (0-based)
paginateSizequerynoItems per page

Responses: 200, 400, 401, 500

POST /api/v1/windows_agent/communicate​

Windows Agent Windows Agent Communicate

Request body: AgentWithDetails

Responses: 200, 400, 401, 500

POST /api/v1/windows_agent/logs​

Windows Agent Logs

Responses: 200, 400, 401, 500