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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
PATCH /api/v1/organizations/{id}/billing-profile
Update Organization Billing Profile
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: OrganizationBillingProfile
Responses: 200, 400, 401, 500
Scanner Profiles
GET /api/v1/administration/scanner_profiles
List Scan Profiles
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/scanner_profiles/{id}
Get Scan Profile
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/scanner_profiles/{id}
Update Scan Profile
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/scanner_profiles/{profile_id}/host_discovery
Create Host Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Request body: HostDiscovery
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/scanner_profiles/{profile_id}/host_discovery/{id}
Delete Host Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/scanner_profiles/{profile_id}/host_discovery/{id}
Update Host Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/scanner_profiles/{profile_id}/service_discovery
Create Service Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Request body: ServiceDiscovery
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/scanner_profiles/{profile_id}/service_discovery/{id}
Delete Service Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/scanner_profiles/{profile_id}/service_discovery/{id}
Update Service Discovery
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/scanner_profiles/{profile_id}/credentials
Create Credentials
Create credentials for a scan profile
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
Request body: CredentialInput
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/scanner_profiles/{profile_id}/credentials/{id}
Delete Credentials
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/scanner_profiles/{profile_id}/credentials/{id}
Update Credentials
Update credentials for a scan profile
| Parameter | In | Required | Description |
|---|---|---|---|
profile_id | path | yes | profile id identifier |
id | path | yes | id identifier |
Request body: CredentialInput
Responses: 200, 400, 401, 500
Subnets
GET /api/v1/administration/networks/subnets
List Subnets
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
search | query | yes | Search query |
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/networks/subnets/{id}
Delete Subnet
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/networks/subnets/{id}
Get Subnet
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/networks/subnets/{id}
Update Subnet
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: Subnet
Responses: 200, 400, 401, 500
URLs
GET /api/v1/administration/networks/urls
List UR Ls
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
search | query | yes | Search query |
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/networks/urls/{id}
Delete URL
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/networks/urls/{id}
Get URL
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Zones
GET /api/v1/administration/zones
List Zones
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/zones/search
Search Zones
Search zones by name
| Parameter | In | Required | Description |
|---|---|---|---|
search | query | yes | Search 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/zones/{id}
Get Zone
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/zones/{id}
Update Zone
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/zones/{zone_id}/blackout_windows
Add Black Out Windows
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Request body: BlackoutWindowCreate
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/zones/{zone_id}/blackout_windows/{id}
Delete Black Out Windows
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/zones/{zone_id}/blackout_windows/{id}
Update Blackout Window
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/zones/{zone_id}/recurring_blackout_windows
Add Recurring Black Out Windows
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/zones/{zone_id}/recurring_blackout_windows/{id}
Update Recurring Blackout Window
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/zones/{zone_id}/excluded_hosts/{id}
Delete Excluded Host
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/zones/{zone_id}/subnets
Add Zone Subnet
Add a subnet to a zone
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Request body: HandleAddZoneSubnetRequest
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/zones/{zone_id}/subnets/{id}
Delete Zone Subnet
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/zones/{zone_id}/urls
Add Zone URL
Add a URL to a zone
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Request body: HandleAddZoneURLRequest
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/zones/{zone_id}/urls/{id}
Delete Zone URL
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
Zones / Scan Schedules
GET /api/v1/administration/scan_schedules/{id}
Get Scan Schedule
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/zones/{zone_id}/scan_schedules
Create Scan Schedule
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
Request body: ScanScheduleCreate
Responses: 200, 400, 401, 500
DELETE /api/v1/administration/zones/{zone_id}/scan_schedules/{id}
Delete Scan Schedule
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/zones/{zone_id}/scan_schedules/{id}
Update Scan Schedule
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
zone_id | path | yes | zone id identifier |
id | path | yes | id identifier |
Request body: HandleToggleScanScheduleRequest
Responses: 200, 400, 401, 500
Tags
GET /api/v1/administration/tags
List Tags
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/tags/search
Search Tags
Search tags by name
| Parameter | In | Required | Description |
|---|---|---|---|
search | query | yes | Search query |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/tags/{id}
Update Tags
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: TagUpdate
Responses: 200, 400, 401, 500
Domains
GET /api/v1/administration/networks/domains
List Domains
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/networks/domains/{id}
Get Domain
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Files
GET /api/v1/administration/files
List Organization Files
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/files/{id}
Get Organization File
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/files/{id}/download
Download Organization File
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Users
GET /api/v1/administration/users
Administration Administration List Users
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/users/{id}
Administration Administration Get User
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/users/{id}
Administration Administration Update User
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: UserUpdate
Responses: 200, 400, 401, 500
GET /api/v1/governance/users/{id}/business_units
Get User Business Units
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
PATCH /api/v1/governance/users/{id}/business_units
Assign User Business Units
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: HandleAssignUserBusinessUnitsRequest
Responses: 200, 400, 401, 500
DELETE /api/v1/governance/users/{id}/business_units/{bu_id}
Remove User Business Unit
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
bu_id | path | yes | bu id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/governance/users/{id}/business_units/{bu_id}
Add User Business Unit
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
bu_id | path | yes | bu id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/users
Platform-administration Platform-administration List Users
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/users/{id}
Platform-administration Platform-administration Get User
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/users/{id}
Platform-administration Platform-administration Update User
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
Identity Providers
GET /api/v1/administration/identity_providers
Administration Administration List Identity Providers
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/identity_providers/{alias}
Administration Administration Get Identity Provider
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/identity_providers/{alias}
Update Identity Provider
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias identifier |
Request body: IdentityProviderUpdate
Responses: 200, 400, 401, 500
GET /api/v1/iem/inventory/identity-providers
Iem Iem List Identity Providers
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/iem/inventory/identity-providers/{id}
Iem Iem Get Identity Provider
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/identity_providers
List Admin Identity Providers
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/identity_providers/{alias}
Get Admin Identity Provider
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/identity_providers/{alias}
Update Admin Identity Provider
| Parameter | In | Required | Description |
|---|---|---|---|
alias | path | yes | alias 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/notification_settings/{id}
Get Notification Setting
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/administration/notification_settings/{id}
Update Notification Setting
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/global_notification_settings/{id}
Get Global Notification Setting
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/global_notification_settings/{id}
Update Global Notification Setting
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: GlobalNotificationSettingsUpdate
Responses: 200, 400, 401, 500
Remediation SLA
GET /api/v1/governance/remediation-sla
Get Remediation SLA
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
buId | path | yes | buId identifier |
Responses: 200, 400, 401, 500
GET /api/v1/governance/remediation-sla/business-units/{buId}
Get BU Override
| Parameter | In | Required | Description |
|---|---|---|---|
buId | path | yes | buId identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/governance/remediation-sla/business-units/{buId}
Upsert BU Override
| Parameter | In | Required | Description |
|---|---|---|---|
buId | path | yes | buId 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Entitlements / Subscription
GET /api/v1/administration/billing-profile
Get Own Billing Profile
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
code | path | yes | code identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/billing
Get Billing Info
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/invoices
Get Invoices
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/usage
Get Usage
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/usage/forecast
Get Usage Forecast
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/usage/history
Get Usage History
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/billing/catalog
Get Billing Catalog
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Entitlements / Quotes
GET /api/v1/administration/entitlements/subscription/quotes
List Org Quotes
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/quotes/{id}
Get Org Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/entitlements/subscription/quotes/{id}/accept
Accept Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
POST /api/v1/administration/entitlements/subscription/quotes/{id}/decline
Decline Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/quotes/{id}/document
Download Org Quote Document
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Entitlements / Credits
GET /api/v1/administration/entitlements/subscription/credits
List Credit Balances
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/administration/entitlements/subscription/credits/{id}/ledger
Get Credit Ledger
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Entitlements / SLA
GET /api/v1/administration/entitlements/subscription/sla
Get SLA Terms
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/organizations/{id}
Organizations Organizations Get Organization
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/organizations/{id}
Organizations Organizations Update Organization
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: OrganizationUpdate
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/organizations
Platform-administration Platform-administration List Organizations
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/organizations/{id}
Platform-administration Platform-administration Get Organization
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/organizations/{id}
Platform-administration Platform-administration Update Organization
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: OrganizationUpdate
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/organizations/{id}/logo
Get Organization Logo
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/organizations/{id}/logo
Upload Organization Logo
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Resource Utilization
GET /api/v1/platform-administration/siem/usage
Get Siem Usage
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/siem/usage/by-source
Get Siem Usage By Source
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/siem/usage/{id}
Get Siem Usage For Org
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Audit Logs
GET /api/v1/platform-administration/audit-logs
Platform-administration Platform-administration List Audit Logs
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/clients/{org_id}
Get MSP Client Detail
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/clients/{org_id}/snapshots
Get Client Snapshots
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/billing/clients/{org_id}/transition
Assign Transition Plan
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Request body: HandleAssignTransitionPlanRequest
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/pool
Get Pool Utilization
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/revenue
Get Revenue Report
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/visible-plans
Get Admin Visible Plans
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Billing / Plan Catalogs
GET /api/v1/billing/plan-addons
Billing Billing List All Plan Addons
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/plan-addons
Platform-administration Platform-administration List All Plan Addons
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/plans
Get All Plans
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/plans/{id}
Get Plan Detail
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/billing/plans/{id}
Update Plan
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: PlanCatalogUpdate
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/plans/{id}/addons
Get Plan Addons
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/billing/plans/{id}/addons
Attach Plan Addon
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: PlanAddonAttach
Responses: 200, 400, 401, 500
DELETE /api/v1/platform-administration/billing/plans/{id}/addons/{addon_item_id}
Detach Plan Addon
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
addon_item_id | path | yes | addon item id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/billing/plans/{id}/addons/{addon_item_id}
Update Plan Addon
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
addon_item_id | path | yes | addon item id identifier |
Request body: PlanAddonUpdate
Responses: 200, 400, 401, 500
DELETE /api/v1/platform-administration/billing/plans/{id}/permanent
Delete Plan Permanent
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Billing / Addon Items
GET /api/v1/platform-administration/billing/gates
Get Gate Catalog
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
Billing / Overage Rate Cards
GET /api/v1/platform-administration/billing/addon-items
Get Addon Items
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/addon-items/{id}
Get Addon Item Detail
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/billing/addon-items/{id}
Update Addon Item
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: AddonItemUpdate
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/overage-rate-cards
Get Overage Rate Cards
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/organizations/{id}/billing-policy
Set Org Billing Policy
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/organizations/{id}/overages
Update Contract Overages
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Billing / Settings
GET /api/v1/platform-administration/billing/settings
Get Billing Settings
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/billing/settings
Update Billing Settings Admin
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/settings/logo
Get Company Logo
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/billing/settings/logo
Upload Company Logo
Responses: 200, 400, 401, 500
Billing / Quotes
GET /api/v1/platform-administration/billing/quotes
List Quotes
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/quotes/{id}
Get Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/billing/quotes/{id}
Update Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Request body: UpdateQuoteInput
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/billing/quotes/{id}/clone
Clone Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/billing/quotes/{id}/document
Download Quote Document
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
POST /api/v1/platform-administration/billing/quotes/{id}/send
Send Quote
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
Billing / SLA
GET /api/v1/platform-administration/sla/requests
Get Pending SLA Requests
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/sla/requests/{id}
Get SLA Request By ID
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/sla/requests/{id}
Review SLA Request
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id 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
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/sla/overrides/{org_id}
Get Org SLA Override
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
Billing / Licensing
POST /api/v1/platform-administration/organizations/{id}/credit-grants
Grant Organization Credits
| Parameter | In | Required | Description |
|---|---|---|---|
id | path | yes | id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/organizations/{org_id}/entitlements
Get Entitlements By Org ID
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
PATCH /api/v1/platform-administration/organizations/{org_id}/entitlements
Update Entitlements
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org 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
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/metering/usage/{org_id}/history
Get Usage History By Org
| Parameter | In | Required | Description |
|---|---|---|---|
org_id | path | yes | org id identifier |
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/engagements
Get Admin Engagements
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/engagements/aggregations
Get Admin Engagement Aggregations
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/engagements/requests
Get Admin Pending Requests
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items per page |
Responses: 200, 400, 401, 500
GET /api/v1/platform-administration/engagements/sla
Get SLA Summary
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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
| Parameter | In | Required | Description |
|---|---|---|---|
paginateFrom | query | no | Pagination offset (0-based) |
paginateSize | query | no | Items 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